Skip to content

D
docs
Commit af282717 authored by Tobias Schmidt's avatar Tobias Schmidt
Browse files
Options

Remove operating section 

The security page was describing our general philosophy and "concepts"
was the closest match for that. Integrations are part of Instrumenting
now.
parent f03bde6b
Show whitespace changes
Inline Side-by-side
Showing with 76 additions and 30 deletions
content/docs/alerting/configuration.md
View file @ af282717
......@@ -26,7 +26,7 @@ sending a HTTP POST request to the `/-/reload` endpoint.
To specify which configuration file to load, use the `-config.file` flag.
```
```bash
./alertmanager -config.file=simple.yml
```
......@@ -55,8 +55,7 @@ The global configuration specifies parameters that are valid in all other
configuration contexts. They also serve as defaults for other configuration
sections.
```
```yaml
global:
# ResolveTimeout is the time after which an alert is declared resolved
# if it has not been updated.
......@@ -100,7 +99,6 @@ inhibit_rules:
[ - <inhibit_rule> ... ]
```
## `<route>`
A route block defines a node in a routing tree and its children. Its optional
......@@ -115,8 +113,7 @@ If an alert does not match any children of a node (no matching child nodes, or
none exist), the alert is handled based on the configuration parameters of the
current node.
```
```yaml
[ receiver: <string> ]
[ group_by: '[' <labelname>, ... ']' ]
......@@ -152,7 +149,7 @@ routes:
### Example
```
```yaml
# The root route with all parameters, which are inherited by the child
# routes if they are not overwritten.
route:
......@@ -179,8 +176,6 @@ route:
team: frontend
```
## `<inhibit_rule>`
An inhibition rule is a rule that mutes an alert matching a set of matchers
......@@ -190,7 +185,7 @@ Both alerts must have a set of equal labels.
__Alerts can inhibit themselves. Avoid writing inhibition rules where
an alert matches both source and target.__
```
```yaml
# Matchers that have to be fulfilled in the alerts to be muted.
target_match:
[ <labelname>: <labelvalue>, ... ]
......@@ -210,14 +205,13 @@ source_match_re:
```
## `<receiver>`
Receiver is a named configuration of one or more notification integrations.
__We're not actively adding new receivers, we recommend implementing custom notification integrations via the [webhook](/docs/alerting/configuration/#webhook_config) receiver.__
```
```yaml
# The unique name of the receiver.
name: <string>
......@@ -240,10 +234,9 @@ victorops_configs:
[ - <victorops_config>, ... ]
```
## `<email_config>`
```
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = false ]
......@@ -273,7 +266,7 @@ to: <tmpl_string>
HipChat notifications use a [Build Your Own](https://confluence.atlassian.com/hc/integrations-with-hipchat-server-683508267.html) integration.
```
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = false ]
......@@ -302,7 +295,7 @@ room_id: <tmpl_string>
PagerDuty notifications are sent via the [PagerDuty API](https://developer.pagerduty.com/documentation/integration/events).
PagerDuty provides documentation on how to integrate [here](https://www.pagerduty.com/docs/guides/prometheus-integration-guide/).
```
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = true ]
......@@ -333,7 +326,7 @@ service_key: <tmpl_secret>
Pushover notifications are sent via the [Pushover API](https://pushover.net/api).
```
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = true ]
......@@ -368,7 +361,7 @@ token: <secret>
Slack notifications are sent via [Slack webhooks](https://api.slack.com/incoming-webhooks).
```
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = false ]
......@@ -390,12 +383,11 @@ channel: <tmpl_string>
[ fallback: <tmpl_string> | default = '{{ template "slack.default.fallback" . }}' ]
```
## `<opsgenie_config>`
OpsGenie notifications are sent via the [OpsGenie API](https://www.opsgenie.com/docs/web-api/alert-api).
```
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = true ]
......@@ -427,11 +419,12 @@ api_key: <secret>
# Additional alert note.
[ note: <tmpl_string> ]
```
## `<victorops_config>`
VictorOps notifications are sent out via the [VictorOps API](https://help.victorops.com/knowledge-base/victorops-restendpoint-integration/)
```
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = true ]
......@@ -458,12 +451,11 @@ routing_key: <string>
```
## `<webhook_config>`
The webhook receiver allows configuring a generic receiver.
```
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = true ]
......@@ -497,7 +489,6 @@ endpoint:
}
```
There is a list of
[integrations](/docs/operating/integrations/#alertmanager-webhook-receiver) with
[integrations](/docs/instrumenting/integrations/#alertmanager-webhook-receiver) with
this feature.
content/docs/operating/integrations.md → content/docs/instrumenting/integrations.md
View file @ af282717
---
title: Integrations
sort_rank: 5
sort_rank: 7
---
# Integrations
......@@ -10,7 +10,6 @@ In addition to [client libraries](/docs/instrumenting/clientlibs/) and
numerous other generic integration points in Prometheus. This page lists some
of the integrations with these.
Not all integrations are listed here, due to overlapping functionality or still
being in development. The [exporter default
port](https://github.com/prometheus/prometheus/wiki/Default-port-allocations)
......@@ -20,42 +19,42 @@ these categories.
## File Service Discovery
For service discovery mechanisms not natively supported by Prometheus,
[file-based service discovery](/docs/operating/configuration/#<file_sd_config>) provides an interface for integrating.
[file-based service discovery](/docs/prometheus/latest/configuration/#<file_sd_config>) provides an interface for integrating.
* [Docker Swarm](https://github.com/ContainerSolutions/prometheus-swarm-discovery)
* [Docker Swarm](https://github.com/ContainerSolutions/prometheus-swarm-discovery)
## Remote Endpoints and Storage
The [remote write](/docs/operating/configuration/#<remote_write>) and [remote read](/docs/operating/configuration/#remote_read)
The [remote write](/docs/prometheus/latest/configuration/#<remote_write>) and [remote read](/docs/operating/configuration/#remote_read)
features of Prometheus allow transparently sending and receiving samples. This
is primarily intended for long term storage. It is recommended that you perform
careful evaulation of any solution in this space to confirm it can handle your
data volumes.
* [Chronix](https://github.com/ChronixDB/chronix.ingester): write
* [Graphite](https://github.com/prometheus/prometheus/tree/master/documentation/examples/remote_storage/remote_storage_adapter): write
* [InfluxDB](https://github.com/prometheus/prometheus/tree/master/documentation/examples/remote_storage/remote_storage_adapter): read and write
* [OpenTSDB](https://github.com/prometheus/prometheus/tree/master/documentation/examples/remote_storage/remote_storage_adapter): write
* [PostgreSQL/TimescaleDB](https://github.com/timescale/prometheus-postgresql-adapter): read and write
* [Chronix](https://github.com/ChronixDB/chronix.ingester): write
* [Graphite](https://github.com/prometheus/prometheus/tree/master/documentation/examples/remote_storage/remote_storage_adapter): write
* [InfluxDB](https://github.com/prometheus/prometheus/tree/master/documentation/examples/remote_storage/remote_storage_adapter): read and write
* [OpenTSDB](https://github.com/prometheus/prometheus/tree/master/documentation/examples/remote_storage/remote_storage_adapter): write
* [PostgreSQL/TimescaleDB](https://github.com/timescale/prometheus-postgresql-adapter): read and write
## Alertmanager Webhook Receiver
For notification mechanisms not natively supported by the Alertmanager, the
[webhook receiver](/docs/alerting/configuration/#webhook_config) allows for integration.
* [JIRA example](https://github.com/fabxc/jiralerts)
* [Phabricator / Maniphest](https://github.com/knyar/phalerts)
* [SMS](https://github.com/messagebird/sachet): supports [multiple providers](https://github.com/messagebird/sachet/blob/master/examples/config.yaml)
* [Telegram bot](https://github.com/inCaller/prometheus_bot)
* [JIRA example](https://github.com/fabxc/jiralerts)
* [Phabricator / Maniphest](https://github.com/knyar/phalerts)
* [SMS](https://github.com/messagebird/sachet): supports [multiple providers](https://github.com/messagebird/sachet/blob/master/examples/config.yaml)
* [Telegram bot](https://github.com/inCaller/prometheus_bot)
## Management
Prometheus does not include configuration management functionality, allowing
you to integrate it with your existing systems or build on top of it.
* [Prometheus Operator](https://github.com/coreos/prometheus-operator): Manages Prometheus on top of Kubernetes
* [Promgen](https://github.com/line/promgen): Web UI and configuration generator for Prometheus and Alertmanager
* [Prometheus Operator](https://github.com/coreos/prometheus-operator): Manages Prometheus on top of Kubernetes
* [Promgen](https://github.com/line/promgen): Web UI and configuration generator for Prometheus and Alertmanager
## Other
* [PushProx](https://github.com/RobustPerception/PushProx): Proxy to transverse NAT and similar network setups
* [PushProx](https://github.com/RobustPerception/PushProx): Proxy to transverse NAT and similar network setups
content/docs/operating/index.md deleted 100644 → 0
View file @ f03bde6b
---
title: Operating
sort_rank: 5
nav_icon: cog
---
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Technounit-GROUP 2023