grafana/contribute/backend/package-hierarchy.md

Package hierarchy

The Go packages in Grafana should be packaged by feature, keeping packages as small as reasonable while retaining a clear sole ownership of a single domain.

Ben Johnson's standard package layout serves as inspiration for the way we organize packages.

Principles of how to structure a service in Grafana

To learn how to structure a Grafana service, refer to our documentation.

Domain types and interfaces should be in local "root" packages

Let's say you're creating a "tea pot" service. You should place everything another service needs to interact with the tea pot service in pkg/services/teapot. Choose a name according to the Go package naming conventions.

Typically, you have one or more interfaces that your service provides in the root package. Also, you should have any types, errors, and other constants that makes sense for another service to interact with the tea pot service to use.

Avoid depending on other services when structuring the root package to reduce the risk of running into circular dependencies.

Sub-packages should depend on roots, not the other way around

Small to medium-sized packages should be able to have only a single sub-package containing the implementation of the service. By moving the implementation into a separate package we reduce the risk of triggering circular dependencies.

Note: In Go, circular dependencies are evaluated per package, and this structure logically moves it to be per type or function declaration.

Large packages may need to utilize multiple sub-packages at the discretion of the implementor. Keep interfaces and domain types to the root package.

Try to name sub-packages for project-wide uniqueness

Prefix sub-packages with the service name or an abbreviation of the service name, whichever is more appropriate, to provide a unique package name. This allows teaimpl to be distinguished from coffeeimpl without the need for package aliases, and encourages the use of the same name to reference your package throughout the codebase.

A well-behaving service provides test doubles for itself

Other services may depend on your service, and it's good practice to provide means for those services to set up a test instance of the dependency as needed. Refer to Google's Testing on the Toilet: Know Your Test Doubles for a brief explanation of how we semantically aim to differentiate fakes, mocks, and stubs within our codebase.

Place test doubles in a sub-package to your root package named <servicename>test or <service-abbreviation>test, such that the teapot service may have the teapottest or teatest.

A stub or mock may be sufficient if the service is not a dependency of a lot of services or if it's called primarily for side effects so that a no-op default behavior makes sense.

Services which serve many other services and where it's feasible should provide an in-memory backed test fake that can be used like the regular service without the need of complicated setup.

Separate store and logic

When building a new service, collect data validation, manipulation, scheduled events, and so forth, in a service implementation. This implementation should be built so that it is agnostic about its store.

The storage should be an interface that is not directly called from outside the service and should be kept to a minimum complexity to provide the functionality necessary for the service.

Use a simple litmus test to determine whether an in-memory implementation is a feasible test-double to assess the service. This will reduce the complexity of the storage interface.

Outside the service root

Some parts of the service definition remain outside the service directory and reflect the legacy package hierarchy. As of June 2022, the parts that remain outside the service are migrations and API endpoints.

Migrations

The pkg/services/sqlstore/migrations package contains all migrations for SQL databases for all Grafana services except for Grafana Enterprise. Migrations are written per the database.md document.

API endpoints

The pkg/api/api.go package contains the endpoint definitions for the most of Grafana HTTP API except for Grafana Enterprise.

Practical example

The following is a simplified example of the package structure for a service that doesn't do anything in particular.

None of the methods or functions are populated and in practice most packages will consist of multiple files. There isn't a Grafana-wide convention for which files should exist and contain what.

pkg/services/alphabetical

package alphabetical

type Alphabetical interface {
  // GetLetter returns either an error or letter.
  GetLetter(context.Context, GetLetterQuery) (Letter, error)
  // ListCachedLetters cannot fail, and doesn't return an error.
  ListCachedLetters(context.Context, ListCachedLettersQuery) Letters
  // DeleteLetter doesn't have any return values other than errors, so it
  // returns only an error.
  DeleteLetter(context.Contxt, DeltaCommand) error
}

type Letter byte

type Letters []Letter

type GetLetterQuery struct {
  ID int
}

// Create queries/commands for methods even if they are empty.
type ListCachedLettersQuery struct {}

type DeleteLetterCommand struct {
  ID int
}

pkg/services/alphabetical/alphabeticalimpl

package alphabeticalimpl

// this name can be whatever, it's not supposed to be used from outside
// the service except for in Wire.
type Svc struct { … }

func ProviceSvc(numbers numerical.Numerical, db db.DB) Svc { … }

func (s *Svc) GetLetter(ctx context.Context, q root.GetLetterQuery) (root.Letter, error) { … }
func (s *Svc) ListCachedLetters(ctx context.Context, q root.ListCachedLettersQuery) root.Letters { … }
func (s *Svc) DeleteLetter(ctx context.Context, q root.DeleteLetterCommand) error { … }

type letterStore interface {
  Get(ctx.Context, id int) (root.Letter, error)
  Delete(ctx.Context, root.DeleteLetterCommand) error
}

type sqlLetterStore struct {
  db.DB
}

func (s *sqlStore) Get(ctx.Context, id int) (root.Letter, error) { … }
func (s *sqlStore) Delete(ctx.Context, root.DeleteLetterCommand) error { … }

Legacy package hierarchy

Note: Many services still adhere to the legacy model as outlined below. While it is okay to extend existing services based on the legacy model, you are strongly encouraged to structure any new services or major refactorings using the new package layout.

Grafana has long used a package-by-layer layout where domain types are placed in pkg/models, all SQL logic in pkg/services/sqlstore, and so forth.

This is an example of how the tea pot service could be structured throughout the codebase in the legacy model:

• pkg/
  • api/
    • api.go contains the endpoints for the
    • tea_pot.go contains methods on the pkg/api.HTTPServer type that interacts with the service based on queries coming in via the HTTP API.
    • dtos/tea_pot.go extends the pkg/models file with types that are meant for translation to and from the API. It's not as commonly present as pkg/models.
  • models/tea_pot.go contains the models for the service, this includes the command and query structs that are used when calling the service or SQL store methods related to the service and also any models representing an abstraction provided by the service.
  • services/
    • sqlstore
      • tea_pot.go contains SQL queries for interacting with stored objects related to the tea pot service.
      • migrations/tea_pot.go contains the migrations necessary to build the
    • teapot/* contains functions or a service for doing logical operations beyond those done in pkg/api or pkg/services/sqlstore for the service.

The implementation of legacy services varies widely from service to service. Some of these files, perhaps many, may be missing and there may be more files related to a service than those listed here.

Some legacy services that provide infrastructure also take care of the integration with several domains. The cleanup service both provides the infrastructure to occasionally run cleanup scripts and defines the cleanup scripts. Ideally, the service should be migrated to only handle the scheduling and synchronization of cleanup jobs. The logic for the individual jobs should be placed with a service that is related to whatever is being cleaned up.