forked from grafana/grafana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
codestyle: styleguide and arch for grafanas backend (grafana#17545)
- Loading branch information
Showing
4 changed files
with
136 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Backend code structure | ||
|
|
||
| Grafanas backend is written in GO using sqlite3/mysql or postgres as storage for dashboards, users etc. When Grafana was born there didnt exist much guides or direction for how to write medium sized application. So there are parts of Grafana code base that didn't quite pan out as we wanted. More about that under current rewrites! :) | ||
|
|
||
| ## Central folders of Grafanas backend | ||
|
|
||
| | folder | description | | ||
| | ------- | ----------- | | ||
| | /pkg/api | Http Handlers and routing. Almost all handler funcs are global which is something we would like to improve in the future. Handlers should be assosicated with a struct that refers to all depedencies. Ex bus. | | ||
| | /pkg/cmd | The binaries that we build. Grafana-server and grafana-cli. | | ||
| | /pkg/components | Mixed content of packages that we copied into Grafana and packages we implemented ourself. The Purpose of this folders should be packages that are too big for util and doesnt belong somewhere else. | | ||
| | /pkg/infra | Packages in infra should be packages that are used in multiple places of Grafana without knowing anything about Grafana domain. E.g. Logs, Metrics, Traces. | | ||
| | /pkg/services | Packages in services are responsible for peristing domain objects and manage the relationship between domain objects. Services should communicate with each other using DI when possible. Most part of Grafana's codebase still relay on Global state for this. Any new features going forwards should use DI. | | ||
| | /pkg/tsdb | All backend implementations of the datasources in Grafana. Used by both Grafanas frontend and alerting. | | ||
| | /pkg/util | Small helper functions that are used in multiple parts of the codebase. Many functions are placed directly in the util folders which is something we want to avoid. Its better to give the util function a more descriptive package name. Ex `errutil`. | | ||
|
|
||
| ## Central components of Grafanas backend | ||
|
|
||
| | package | description | | ||
| | ------- | ----------- | | ||
| | /pkg/bus | The bus! Described more below. | | ||
| | /pkg/models | This is where we keep our domain model. This package should not depend on any package outside standard library. (It does contain some refs within Grafana but that is something we should avoid going forward). | | ||
| | /pkg/registry | service management package. | | ||
| | /pkg/services/alerting | Grafanas alerting services. The alerting engine run in a seperate go routine and should not depend on anything else within Grafana. | | ||
| | /pkg/services/sqlstore | Currently where are database calls resides. | | ||
| | /pkg/setting | settings package for Grafana. Anything related to grafana global configuration should be dealt with in this package. | | ||
|
|
||
| ## Testing | ||
| We value clean & readable code that is loosely coupled and covered by unit tests. This makes it easier to collaborate and maintain the code. In the sqlstore package we do database operations in tests and while some might say that's not suited for unit tests. We think they are fast enough and provide a lot of value. | ||
|
|
||
| The majority of our tests uses go convey but thats something we want to avoid going forward. | ||
| For new tests we want to use standard library and `testify/assert`. | ||
|
|
||
| ## The Bus | ||
| The bus is our way to introduce indirection between the HTTP handlers and sqlstore (responsible for fetching data from the database). Http handlers and sqlstore don't depend on each other. They only depend on the bus and the domain model(pkg/models). This makes it easier to test the code and avoids coupling. More about this under `current rewrite/refactorings` | ||
|
|
||
| ## Services/Repositories | ||
| Services within Grafana should be self-contained and only talk to other parts of Grafana using the bus or repositories that have been made available through Grafana service registry. All services should register themselves to the `registry` package in an init function. Only registration should be done in the init function. Init functions should be avoided as much as possible. | ||
|
|
||
| When Grafana starts all init functions within the services will be called and register themselves. | ||
| Grafana will then create a Graph of all dependencies and inject the services that other services depend on. This is solved with [inject library](https://github.com/facebookgo/inject) in https://github.com/grafana/grafana/blob/master/pkg/cmd/grafana-server/server.go#L75 | ||
|
|
||
| ## Provisionable* | ||
| All new features that require state should be possible to configure using config files. Ex [datasources](https://github.com/grafana/grafana/tree/master/pkg/services/provisioning/datasources), [alert notifiers](https://github.com/grafana/grafana/tree/master/pkg/services/provisioning/notifiers), [dashboards](https://github.com/grafana/grafana/tree/master/pkg/services/provisioning/dashboards), teams etc. Today its only possible to provision datasources and dashboards but this is something we want to support all over Grafana. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Grafana backend codebase | ||
|
|
||
| The code [styleguide](STYLEGUIDE.md) and brief description of the [architecture](ARCHITECTURE.md) | ||
|
|
||
| # On going refactorings. | ||
| These issues are not something we want to address all at once but something we will improve over time. Since Grafana is released at a regular schedule the prefer approuch is to do this in batches. Not only is it easier to review, it also reduces the risk of conflicts when cherry-picking fixes from master to release branches. Changes that spawn multiple locations are therefore prefered in the end of the release cycle since we make fewer patch releases in the end of the cycle. | ||
|
|
||
| ## Global state | ||
| Global state makes testing and debugging software harder and its something we want to avoid when possible. | ||
| Unfortunately, there is quite a lot of global state in Grafana. The way we want to migrate away from this | ||
| is to use the `inject` package to wire up all dependencies either in `pkg/cmd/grafana-server/main.go` or | ||
| self registering using `registry.RegisterService` ex https://github.com/grafana/grafana/blob/master/pkg/services/cleanup/cleanup.go#L25 | ||
|
|
||
| ## Reduce the use of the init() function | ||
| Should only be used to register services/implementations. | ||
|
|
||
| ## Settings refactoring | ||
| The plan is to move all settings to from package level vars in settings package to the [setting.Cfg](https://github.com/grafana/grafana/blob/df917663e6f358a076ed3daa9b199412e95c11f4/pkg/setting/setting.go#L210) struct. To access the settings services/components can inject this setting.Cfg struct. | ||
|
|
||
| [Cfg struct](https://github.com/grafana/grafana/blob/df917663e6f358a076ed3daa9b199412e95c11f4/pkg/setting/setting.go#L210) | ||
| [Injection example](https://github.com/grafana/grafana/blob/df917663e6f358a076ed3daa9b199412e95c11f4/pkg/services/cleanup/cleanup.go#L20) | ||
|
|
||
| ## Reduce the use of Goconvey | ||
| We want to migrated away from using Goconvey and use stdlib testing as its the most common approuch in the GO community and we think it will make it easier for new contributors. Read more about how we want to write tests in the [ARCHITECTURE.MD](/ARCHITECTURE.md#Testing) docs. | ||
|
|
||
| ## Sqlstore refactoring | ||
| The sqlstore handlers all use a global xorm engine variable. This should be refactored to use the Sqlstore instance. | ||
|
|
||
| ## Avoid global HTTP Handler functions | ||
| HTTP handlers should be refactored to so the handler methods are on the HttpServer instance or a more detailed handler struct. E.g (AuthHandler). This way they get access to HttpServer service dependencies (& Cfg object) and can avoid global state | ||
|
|
||
| # Dependency management | ||
|
|
||
| The Grafana project uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies on external packages. This requires a working Go environment with version 1.11 or greater installed. | ||
|
|
||
| All dependencies are vendored in the `vendor/` directory. | ||
|
|
||
| To add or update a new dependency, use the `go get` command: | ||
|
|
||
| ```bash | ||
| # Pick the latest tagged release. | ||
| go get example.com/some/module/pkg | ||
|
|
||
| # Pick a specific version. | ||
| go get example.com/some/module/pkg@vX.Y.Z | ||
| ``` | ||
|
|
||
| Tidy up the `go.mod` and `go.sum` files and copy the new/updated dependency to the `vendor/` directory: | ||
|
|
||
| ```bash | ||
| # The GO111MODULE variable can be omitted when the code isn't located in GOPATH. | ||
| GO111MODULE=on go mod tidy | ||
|
|
||
| GO111MODULE=on go mod vendor | ||
| ``` | ||
|
|
||
| You have to commit the changes to `go.mod`, `go.sum` and the `vendor/` directory before submitting the pull request. | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters