Skip to content

Commit

Permalink
Fix typos and formatting (#31766)
Browse files Browse the repository at this point in the history
  • Loading branch information
CharlieTLe authored Mar 14, 2024
1 parent 763cc42 commit 7dcc12b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions exporter/alertmanagerexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
<!-- end autogenerated section -->

Exports OTEL Events (SpanEvent in Tracing added by AddEvent API) as Alerts to [Alertmanager] (https://prometheus.io/docs/alerting/latest/alertmanager/) back-end to notify Errors or Change events.
Exports OTEL Events (SpanEvent in Tracing added by AddEvent API) as Alerts to [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) back-end to notify Errors or Change events.

Supported pipeline types: traces

## Getting Started

The following settings are required:

- `endpoint` : Alertmanager endpoint to send events
- `endpoint`: Alertmanager endpoint to send events
- `severity`: Default severity for Alerts


Expand All @@ -28,8 +28,8 @@ The following settings are optional:
- [HTTP settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/confighttp/README.md)
- [TLS and mTLS settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)
- `generator_url` is the source of the alerts to be used in Alertmanager's payload. The default value is "opentelemetry-collector", and can be set to the URL of the opentelemetry collector.
- `severity_attribute`is the spanevent Attribute name which can be used instead of default severity string in Alert payload
eg: If severity_attribute is set to "foo" and the SpanEvent has an attribute called foo, foo's attribute value will be used as the severity value for that particular Alert generated from the SpanEvent.
- `severity_attribute` is the SpanEvent Attribute name which can be used instead of default severity string in Alert payload
e.g.: If `severity_attribute` is set to "foo" and the SpanEvent has an attribute called foo, foo's attribute value will be used as the severity value for that particular Alert generated from the SpanEvent.


Example config:
Expand All @@ -55,4 +55,4 @@ exporters:
max_interval: 60s
max_elapsed_time: 10m
generator_url: "opentelemetry-collector"
```
```

0 comments on commit 7dcc12b

Please sign in to comment.