grafana / alertmanager-webhook-proxy

A reverse proxy for the Prometheus AlertManager webhook notifier.

The open-source platform for monitoring and observability

Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data-driven culture:

• Visualizations: Fast and flexible client side graphs with a multitude of options. Panel plugins offer many different ways to visualize metrics and logs.
• Dynamic Dashboards: Create dynamic & reusable dashboards with template variables that appear as dropdowns at the top of the dashboard.
• Explore Metrics: Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side.
• Explore Logs: Experience the magic of switching from metrics to logs with preserved label filters. Quickly search through all your logs or streaming them live.
• Alerting: Visually define alert rules for your most important metrics. Grafana will continuously evaluate and send notifications to systems like Slack, PagerDuty, VictorOps, OpsGenie.
• Mixed Data Sources: Mix different data sources in the same graph! You can specify a data source on a per-query basis. This works for even custom datasources.

Get started

• Get Grafana
• Installation guides

Unsure if Grafana is for you? Watch Grafana in action on play.grafana.org!

Documentation

The Grafana documentation is available at grafana.com/docs.

Contributing

If you're interested in contributing to the Grafana project:

• Start by reading the Contributing guide.
• Learn how to set up your local environment, in our Developer guide.
• Explore our beginner-friendly issues.
• Look through our style guide and Storybook.

Get involved

• Follow @grafana on Twitter.
• Read and subscribe to the Grafana blog.
• If you have a specific question, check out our discussion forums.
• For general discussions, join us on the official Slack team.

This project is tested with BrowserStack

License

Grafana is distributed under AGPL-3.0-only. For Apache-2.0 exceptions, see LICENSING.md.

alertmanager-webhook-proxy's Issues

template creation

I have an easy webservice that just takes 2 pieces of info in json format:
(@{"NotificationType"="ChannelName";"Message"="Destroy all humans"}

How can I craft the template, to put all the information from the alert into Message, and leave NotificationType a static name?
I always seem to get this error: json: cannot unmarshal string into Go struct field Alert.alerts.labels of type template.KV

No template function for JSON string escaping

I tried using the printf "%q" function in go to encode double-quoted strings (like this: {{ printf "%q" .Annotations.description }}). This renders correct JSON strings in most cases, but it's not perfect.

I wasn't able to figure out how to use the jq template function. alertmanager-webhook-proxy crashes when I try to load the template.
I tried {{ jq .Labels.example }} and {{ .Labels.example | jq }}.

Reference documentation:

• text/template global functions:
  https://pkg.go.dev/text/template#hdr-Functions
• fmt.Sprintf syntax:
  https://pkg.go.dev/fmt#hdr-Printing
• JSON string specification:
  https://datatracker.ietf.org/doc/html/rfc8259#section-7
• Go string literals:
  https://go.dev/ref/spec#String_literals

Similarities between Go string literals and JSON strings:

• Double quotes delimiters.
• Two character escape sequences \\, \", \n, \t, and others.

Differences:

• Go literal strings have \nnn (octal), \xFF, \uFFFF and \UFFFFFFFF character sequences.
• JSON strings only have \uFFFF and a few 2-character sequences.

For example, in Go printf "%q" a null character will be represented as \x00, but JSON would require \u0000.

In JSON, all control characters U+0000 to U+001F must be escaped. Therefore, any control character that would not be represented as a 2-character escape sequence would produce bad JSON and cause an error.

Resolution:

I ended up re-writing in Python (because I am more familiar with that) so that I can use a JSON serialiser instead of a text template engine. This way, at least the JSON syntax is always correct.

No logs

It's difficult to troubleshoot HTTP transactions because the application doesn't log incoming and outgoing HTTP requests and responses.