Grizzly Documentation

Grizzly is a command line tool designed to manage observability resources as code. It allows you to define resources like dashboards, alerting rules, and recording rules within your codebase, enabling integration into continuous deployment (CD) pipelines. This ensures that observability configurations are updated automatically whenever your application is deployed.

Supported Providers and Resources

Grafana

• Alerting contact points
• Alerting notification templates
• Alerting notification policy
• Alert rule groups
• Dashboards
• Dashboard folders
• Datasources
• Library elements

Prometheus

• Alerts
• Recording rules

Grafana Synthetic Monitoring

• Monitoring Checks

Deprecation Warning

Grizzly has been marked for deprecation and will be superseded by grafanactl. Developers should consider migrating to grafanactl for managing observability resources. For more context, refer to the discussion.

The pkg/grafana package provides a Grizzly provider that includes a suite of Handlers designed to manage various Grafana resources. You can use these Handlers to programmatically manage the lifecycle of observability components within Grafana.

Supported resource types include:

• Dashboards
• Datasources
• Alert and Recording Rules
• Synthetic Monitoring Checks

In Jsonnet, you can use the :: operator to define "hidden" elements. Elements defined with :: are internal to the script and will not be visible in the final rendered output. This is useful for defining intermediate data structures, libraries, or logic that should only be accessed by other parts of the script via reference.

grizzly_alerts:: {
  rules: [...]
}

Hugo uses different template types to determine how content is rendered:

• Home Page Template: Used only for the site's root page (e.g., layouts/index.html).
• Single Templates: Used to generate output for an individual content file (e.g., single.html).
• List Templates: Used to group multiple pieces of content together (e.g., list.html).

Template Selection Logic: When Hugo renders a piece of content, it searches for a template using the content's section or type. It follows this priority:

1. A template matching the specific section or type (e.g., post/single.html).
2. A template in the _default/ directory (e.g., _default/single.html).

Hugo uses a configuration file to override default site settings. The file can be written in TOML, YAML, or JSON. Hugo determines the format based on the file extension.

Common configuration tasks include:

• Specifying alternate locations for the content/ directory.
• Specifying alternate locations for the themes/ directory.
• Defining where the public/ output directory should be located.

Note: If you use YAML or JSON instead of TOML, ensure you rename the file extension accordingly (e.g., config.yaml or config.json).

Go templates are HTML files that use double curly braces {{ }} to embed variables and functions.

• Variables/Functions: Accessed via {{ variable_name }} or {{ function_name arg1 arg2 }}.
• Parameters: Separated by spaces.
• Dot Notation: Used to access methods and fields (e.g., {{ .Params.bar }}).
• Grouping: Use parentheses to group expressions, such as in complex conditionals.

<!-- Accessing a variable -->
{{ foo }}

<!-- Calling a function with parameters -->
{{ add 1 2 }}

<!-- Accessing fields via dot notation -->
{{ .Params.bar }}

<!-- Grouping with parentheses -->
{{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}

The dot . represents the current context.

Crucial Behavior: The value of . changes inside loops or with blocks. Inside a range loop, . refers to the current item in the iteration, not the global page data. To access global data (like the site title) inside a loop, you must assign it to a variable before entering the loop.

{{ $title := .Site.Title }}
{{ range .Params.tags }}
  <!-- Inside the loop, '.' is the tag, not the site. We use '$title' to access the site title -->
  <a href="{{ . | urlize }}">{{ . }}</a> - {{ $title }}
{{ end }}