domain

type AlertRuleFilterParams ¶

type AlertRuleFilterParams struct {
	Folder               string
	UID                  string
	Label                []string
	IgnoreWatchedFolders bool
}

AlertRuleFilterParams defines the filtering criteria used to narrow down alert rules during import or export operations. It allows filtering by folder name, a set of labels, and provides an option to ignore folder-based rules.

type AlertRuleWithNestedFolder ¶

type AlertRuleWithNestedFolder struct {
	*models.ProvisionedAlertRule
	NestedPath string
}

type ConnectionPermissionItem ¶

type ConnectionPermissionItem struct {
	Connection  *models.DataSourceListItemDTO
	Permissions []*models.ResourcePermissionDTO
}

ConnectionPermissionItem holds a connection and its associated permissions.

type ContextHandler ¶

type ContextHandler struct {
	// contains filtered or unexported fields
}

func NewContextHandler(h slog.Handler, out *os.File, err *os.File, opts *tint.Options) *ContextHandler

func (h *ContextHandler) Enabled(ctx context.Context, level slog.Level) bool

func (h *ContextHandler) Handle(ctx context.Context, r slog.Record) error

func (h *ContextHandler) WithAttrs(attrs []slog.Attr) slog.Handler

func (h *ContextHandler) WithGroup(name string) slog.Handler

type DashboardAndPermissions ¶

type DashboardAndPermissions struct {
	Dashboard   *NestedHit
	Permissions []*models.ResourcePermissionDTO
}

DashboardAndPermissions holds a dashboard reference and its unified permission list. Permissions is always []*models.ResourcePermissionDTO regardless of the Grafana API version in use — the v1 path maps DashboardACLInfoDTO to ResourcePermissionDTO internally before returning, so callers always work with a single type.

type DashboardPermissionsGdg ¶ added in v0.9.4

type DashboardPermissionsGdg struct {
	DashboardUID  string                          `json:"dashboard_uid"`
	DashboardName string                          `json:"dashboard_name"`
	GdgApiVersion string                          `json:"gdg_api_version"`
	Permissions   []*models.ResourcePermissionDTO `json:"permissions"`
}

DashboardPermissionsGdg is the GDG on-disk wrapper for a dashboard's permission set. It is written by DownloadDashboardPermissions and read by UploadDashboardPermissions.

• DashboardUID is the Grafana dashboard UID — used to target the correct dashboard when uploading permissions.
• DashboardName is the human-readable title, stored for readability only.
• GdgApiVersion records the API version at download time (GdgPermApiVersionV1 or GdgPermApiVersionV2). At upload time this is compared against the target server version to route to the correct API and detect format mismatches.
• Permissions is always []*models.ResourcePermissionDTO regardless of API version — the v1 path maps DashboardACLInfoDTO → ResourcePermissionDTO before writing, keeping the on-disk format unified.

type DashboardResourceV2 ¶ added in v0.9.4

type DashboardResourceV2 struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	Spec              dashboardv2.Dashboard `json:"spec"`
	Status            map[string]any        `json:"status,omitempty"`
}

DashboardResourceV2 is the pure App Platform wire envelope for a dashboard. It contains only the fields that Grafana sends and receives — no GDG-internal bookkeeping. This makes marshalling/unmarshalling clean and removes the need for the intermediate dashboardV2Payload type in the adapter layer.

func (d *DashboardResourceV2) FolderUID() string

func (d *DashboardResourceV2) SetFolderUID(uid string)

type DashboardV2Gdg ¶ added in v0.9.4

type DashboardV2Gdg struct {
	Resource      *DashboardResourceV2 `json:"resource"`
	NestedPath    string               `json:"nested_path"`
	GdgApiVersion string               `json:"gdg_api_version"`
}

DashboardV2Gdg is the GDG-internal wrapper around a DashboardResourceV2. It carries bookkeeping fields that are written to local storage alongside the resource but are never sent to the Grafana API.

• Resource holds the pure API envelope (what Grafana sends/receives).
• NestedPath is the resolved folder path used for the on-disk storage layout.
• GdgApiVersion records the API version in use at download time (GdgApiVersionV1 or GdgApiVersionV2). At upload time this is compared against the target server to detect format mismatches early.

type FilterReader ¶

type FilterReader func(context.Context, FilterType, any) (any, error)

type FilterType ¶

type FilterType string

FilterType Currently supported filters

const (
	TagsFilter          FilterType = "TagsFilter"
	DashFilter          FilterType = "DashFilter"
	FolderFilter        FilterType = "FolderFilter"
	AlertRuleFilterType            = "AlertRuleFilter"
	Name                FilterType = "Name"
	UID                 FilterType = "UID"
	ConnectionName      FilterType = "ConnectionName" // used for Connection name
	AuthLabel           FilterType = "AuthLabel"
	OrgFilter           FilterType = "OrgFilter"
)

func (s FilterType) String() string

type InputValidation ¶

type InputValidation func(ctx context.Context, value any, expected any) error

type NestedHit ¶

type NestedHit struct {
	*models.Hit
	NestedPath string
}

NestedHit represents a Dashboard or Folder with an associated nested path in dashboard filtering.

type OrgsDTOWithPreferences ¶

type OrgsDTOWithPreferences struct {
	Organization *models.OrgDTO          `json:"organization"`
	Preferences  *models.PreferencesSpec `json:"preferences"` // Preferences are preferences associated with a given org.  theme, dashboard, timezone, etc
}

OrgsDTOWithPreferences represents an organization and its preferences.

type PluginRegistryEntry ¶ added in v0.9.4

type PluginRegistryEntry struct {
	Name        string               `json:"name"`
	Type        string               `json:"type"`
	Description string               `json:"description"`
	Source      string               `json:"source"`
	URLPattern  string               `json:"urlPattern"`
	Versions    []PluginVersionEntry `json:"versions"`
}

PluginRegistryEntry represents a single plugin entry in the remote registry JSON array.

func (e *PluginRegistryEntry) FindVersion(version string) *PluginVersionEntry

func (e *PluginRegistryEntry) LatestVersion() *PluginVersionEntry

func (e *PluginRegistryEntry) ResolveURL(version string) string

type PluginVersionEntry ¶ added in v0.9.4

type PluginVersionEntry struct {
	Version        string   `json:"version"`
	ConfigFields   []string `json:"config_fields"`
	MinimumVersion string   `json:"minimum_version"`
	MaximumVersion string   `json:"maximum_version"`
}

PluginVersionEntry describes one released version of a plugin and which config fields the caller must supply when using it.

func (e *PluginVersionEntry) IsValid() bool

type Processor ¶

type Processor func(ctx context.Context, item any) (any, error)

type ProcessorEntity ¶

type ProcessorEntity struct {
	Name string
	// priority  int8
	// postProcess bool
	Processor Processor
}

func (p ProcessorEntity) Validate() error

type ResourceType ¶

type ResourceType string

const (
	ConnectionPermissionResource ResourceType = "connections-permissions"
	ConnectionResource           ResourceType = "connections"
	DashboardPermissionsResource ResourceType = "dashboards-permissions"
	DashboardResource            ResourceType = "dashboards"
	FolderPermissionResource     ResourceType = "folders-permissions"
	FolderResource               ResourceType = "folders"
	LibraryElementResource       ResourceType = "libraryelements"
	OrganizationResource         ResourceType = "organizations"
	OrganizationMetaResource     ResourceType = "org"
	TeamResource                 ResourceType = "teams"
	UserResource                 ResourceType = "users"
	TemplatesResource            ResourceType = "templates"
	SecureSecretsResource        ResourceType = "secure"
	AlertingResource             ResourceType = "alerting"
	AlertingRulesResource        ResourceType = "alerting-rules"
)

func (s *ResourceType) GetPath(basePath string, orgName string) string

func (s *ResourceType) String() string

type ServiceAccountDTOWithTokens ¶

type ServiceAccountDTOWithTokens struct {
	ServiceAccount *models.ServiceAccountDTO
	Tokens         []*models.TokenDTO
}

ServiceAccountDTOWithTokens represents a service account and its associated tokens.

type UserProfileWithAuth ¶

type UserProfileWithAuth struct {
	models.UserProfileDTO
	Password string // #nosec G117 is the user's temporary generated password
}

UserProfileWithAuth embeds UserProfileDTO and adds a Password field for authentication.

type WithNested ¶

type WithNested[T any] struct {
	Entity     *T
	NestedPath string
}

WithNested represents an entity with a nested path for filtering purposes.