Skip to content

Commit 8708703

Browse files
gabriel-rhgabriel-rh
authored
Merge pull request #94059 from gabriel-rh/migrate-old-content-log-alerts
OBSDOCS-1972 migrate old content - add in log_alerts folder
2 parents 941a53a + 84528d6 commit 8708703

File tree

7 files changed

+80
-0
lines changed

7 files changed

+80
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,11 @@ Topics:
9090
File: cluster-logging-dashboards
9191
- Name: Log visualization with Kibana
9292
File: logging-kibana
93+
---
94+
Name: Logging alerts
95+
Dir: logging_alerts
96+
Topics:
97+
- Name: Default logging alerts
98+
File: default-logging-alerts
99+
- Name: Custom logging alerts
100+
File: custom-logging-alerts

‎logging_alerts/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/

‎logging_alerts/custom-logging-alerts.adoc

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="custom-logging-alerts"]
3+
include::_attributes/common-attributes.adoc[]
4+
= Custom logging alerts
5+
:context: custom-logging-alerts
6+
7+
toc::[]
8+
9+
In logging 5.7 and later versions, users can configure the LokiStack deployment to produce customized alerts and recorded metrics. If you want to use customized link:https://grafana.com/docs/loki/latest/alert/[alerting and recording rules], you must enable the LokiStack ruler component.
10+
11+
LokiStack log-based alerts and recorded metrics are triggered by providing link:https://grafana.com/docs/loki/latest/query/[LogQL] expressions to the ruler component. The {loki-op} manages a ruler that is optimized for the selected LokiStack size, which can be `1x.extra-small`, `1x.small`, or `1x.medium`.
12+
13+
To provide these expressions, you must create an `AlertingRule` custom resource (CR) containing Prometheus-compatible link:https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/[alerting rules], or a `RecordingRule` CR containing Prometheus-compatible link:https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/[recording rules].
14+
15+
Administrators can configure log-based alerts or recorded metrics for `application`, `audit`, or `infrastructure` tenants. Users without administrator permissions can configure log-based alerts or recorded metrics for `application` tenants of the applications that they have access to.
16+
17+
Application, audit, and infrastructure alerts are sent by default to the {ocp-product-title} monitoring stack Alertmanager in the `openshift-monitoring` namespace, unless you have disabled the local Alertmanager instance. If the Alertmanager that is used to monitor user-defined projects in the `openshift-user-workload-monitoring` namespace is enabled, application alerts are sent to the Alertmanager in this namespace by default.
18+
19+
include::modules/configuring-logging-loki-ruler.adoc[leveloffset=+1]
20+
include::modules/loki-rbac-rules-permissions.adoc[leveloffset=+1]
21+
22+
23+
[role="_additional-resources"]
24+
.Additional resources
25+
* link:https://docs.openshift.com/container-platform/latest/authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions]
26+
27+
include::modules/logging-enabling-loki-alerts.adoc[leveloffset=+1]
28+
29+
[role="_additional-resources"]
30+
[id="additional-resources_custom-logging-alerts"]
31+
== Additional resources
32+
//TODO ROSA
33+
ifdef::openshift-dedicated,openshift-rosa[]
34+
* xref:../../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[About {product-title} monitoring]
35+
endif::openshift-dedicated,openshift-rosa[]
36+
37+
* link:https://docs.openshift.com/container-platform/latest/observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {ocp-product-title} monitoring]
38+
* link:https://docs.openshift.com/container-platform/latest/post_installation_configuration/configuring-alert-notifications.adoc#configuring-alert-notifications[Configuring alert notifications]
39+
// maybe need an update to https://docs.openshift.com/container-platform/4.13/observability/monitoring/monitoring-overview.html#default-monitoring-targets_monitoring-overview to talk about Loki and Vector now? Are these part of default monitoring?

‎logging_alerts/default-logging-alerts.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="default-logging-alerts"]
3+
include::_attributes/common-attributes.adoc[]
4+
= Default logging alerts
5+
:context: default-logging-alerts
6+
7+
toc::[]
8+
9+
Logging alerts are installed as part of the {clo} installation. Alerts depend on metrics exported by the log collection and log storage backends. These metrics are enabled if you selected the option to *Enable Operator recommended cluster monitoring on this namespace* when installing the {clo}.
10+
11+
Default logging alerts are sent to the {ocp-product-title} monitoring stack Alertmanager in the `openshift-monitoring` namespace, unless you have disabled the local Alertmanager instance.
12+
13+
// TODO MONITORING REMOVE DEPENDENCY
14+
include::modules/monitoring-accessing-the-alerting-ui.adoc[leveloffset=+1]
15+
include::modules/logging-collector-alerts.adoc[leveloffset=+1]
16+
include::modules/logging-vector-collector-alerts.adoc[leveloffset=+1]
17+
include::modules/logging-fluentd-collector-alerts.adoc[leveloffset=+1]
18+
include::modules/cluster-logging-elasticsearch-rules.adoc[leveloffset=+1]
19+
20+
[role="_additional-resources"]
21+
[id="additional-resources_default-logging-alerts"]
22+
== Additional resources
23+
// TODO ROSA
24+
ifdef::openshift-dedicated,openshift-rosa[]
25+
* xref:../../../observability/monitoring/managing-alerts.adoc#modifying-core-platform-alerting-rules_managing-alerts[Modifying core platform alerting rules]
26+
endif::openshift-dedicated,openshift-rosa[]
27+
28+
* link:https://docs.openshift.com/container-platform/latest/observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#modifying-core-platform-alerting-rules_managing-alerts-as-an-administrator[Modifying core platform alerting rules]
29+

‎logging_alerts/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

‎logging_alerts/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

‎logging_alerts/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

0 commit comments

Comments
 (0)