Skip to content

Publish Alloy dashboards and alerts in easy-to-use format #5074

@thampiotr

Description

@thampiotr

Component(s)

Alloy mixin

Background

Currently dashboards and alerts in opearations/alloy-mixin force users to get their hands on jsonnet in order to use them. This adds friction.

Proposal

Implement the following improvements:

  • - render the dashboards into JSON files checked-in in our repo - this way it's easy to copy/paste and import to your instance, no need to render any JSONNET stuff
  • fix the existing issue with logs dashboard (parse errors due to broken queries)
  • - optionally publish the dashboards as a zip archive in GH releases so people can fetch them all when they want to feat(mixin): Add zipped dashboards as a release artifact #5603
  • - optionally publish them in grafana.com dashboards catalogue so they can be imported with a simple ID.
  • - Internal to Alloy team: change our internal testing process to automatically update to our latest dashboards so we don't need to be updating them manually in our infrastructure any more... so each time Alloy is released, the matching set of dashboards is also provisioned
  • optional: Add some tutorial / task based document to describe how to get the dashboards and alert rules into your grafana instance?

Tip

React with 👍 if this issue is important to you.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Accepted

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions