Command-line

grafanarmadillo.cmd

Ready-to-run commands for common Grafana templating scenarios.

class grafanarmadillo.cmd.TemplatorOpts(remove_edit_metadata: bool = False, resolve_alert_dashboarduid: bool = False)

Extra options for the templator.

grafanarmadillo.cmd.apply_template_opts(gfn: GrafanaApi, opts: TemplatorOpts, templator: Templator) → Templator

Apply the extra templator options.

grafanarmadillo.cmd.export_alert(gfn: GrafanaApi, src: str, dst: IO, templator: Templator, api_v: UID = 11)

Capture an alert from Grafana.

grafanarmadillo.cmd.export_dashboard(gfn: GrafanaApi, src: str, dst: IO, templator: Templator, api_v: UID = 11)

Capture a dashboard from Grafana.

grafanarmadillo.cmd.import_alert(gfn: GrafanaApi, src: IO, dst: str, templator: Templator, api_v: UID = 11)

Deploy an alert from a template.

grafanarmadillo.cmd.import_dashboard(gfn: GrafanaApi, src: IO, dst: str, templator: Templator, api_v: UID = 11)

Deploy a template to Grafana.

grafanarmadillo.cmd.make_grafana(config) → GrafanaApi

Make a GrafanaApi from the passed config.

grafanarmadillo.cmd.make_templator(gfn: GrafanaApi, mapping, env_grafana, env_template, templator_extra_opts) → Templator

Assemble the templator.

grafanarmadillo.cmd.with_template_options(f)

Add template options to a command.