Skip to content

Commit f25039a

Browse files
committed
observability concept article updated
1 parent c734146 commit f25039a

File tree

6 files changed

+22
-19
lines changed

6 files changed

+22
-19
lines changed

articles/operator-5g-core/concept-observability-analytics.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: SarahBoris
55
ms.author: sboris
66
ms.service: azure-operator-5g-core
77
ms.topic: concept-article #required; leave this attribute/value as-is.
8-
ms.date: 02/21/2024
8+
ms.date: 03/29/2024
99

1010

1111
---
@@ -27,23 +27,24 @@ Azure Operator 5G Core uses the following open source components for observabili
2727
|Observability parameters |Open source components |
2828
|----------------------------|-----------------------|
2929
|Metrics |Prometheus, AlertManager, Grafana |
30-
|Logs |Elasticsearch, Fluentd, and Kibana (EFK); Elastalert |
30+
|Logs |Elasticsearch, FluentD, and Kibana (EFK); Elastalert |
3131
|Tracing |Jaeger, OpenTelemetry Collector |
3232

33-
## EFK logging framework
34-
Elasticsearch, Fluentd, and Kibana (EFK) provide a distributed logging system used for collecting and visualizing the logs to troubleshoot microservices.
33+
## Logging framework
34+
Elasticsearch, FluentD, and Kibana (EFK) provide a distributed logging system used for collecting and visualizing the logs to troubleshoot microservices.
3535

3636
### Architecture
3737
The following diagram shows EFK architecture:
3838

39-
[:::image type="content" source="media/concept-observability-analytics/elasticsearch-fluentd-kibana-architecture.png" alt-text="Diagram of text boxes showing the Elasticsearch, Fluentd, and Kibana (EFK) distributed logging system used to troubleshoot microservices in Azure Operator 5G Core.":::](media/concept-observability-analytics/elasticsearch-fluentd-kibana-architecture-expanded.png#lightbox)
39+
[:::image type="content" source="media/concept-observability-analytics/elasticsearch-fluentd-kibana-architecture.png" alt-text="Diagram of text boxes showing the Elasticsearch, FluentD, and Kibana (EFK) distributed logging system used to troubleshoot microservices in Azure Operator 5G Core.":::](media/concept-observability-analytics/elasticsearch-fluentd-kibana-architecture-expanded.png#lightbox)
4040

4141
> [!NOTE]
42-
> The linked content is available only to customers with a current Affirmed Networks support agreement. To access the content, you must have Affirmed Networks login credentials. If you need assistance, please speak to the Affirmed Networks Support Team.
42+
> Sections of the following linked content is available only to customers with a current Affirmed Networks support agreement. To access the content, you must have Affirmed Networks login credentials. If you need assistance, please speak to the Affirmed Networks Support Team.
4343
44-
The EFK logging framework includes the following components:
44+
The logging framework includes the following components:
45+
46+
- **FluentD** - FluentD is an open-source log collector. FluentD allows you to unify data collection and consumption for better use and understanding of the data. FluentD is deployed as a DaemonSet in the Kubernetes cluster. It collects the logs in each K8s node and streams the logs to Elasticsearch. See [Logs supported by FluentD](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/Fluentd-logs-supported.htm).
4547

46-
- **Fluentd** - Fluentd is an open-source log collector. Fluentd allows you to unify data collection and consumption for better use and understanding of the data. Fluentd is deployed as a DaemonSet in the Kubernetes cluster. It collects the logs in each K8s node and streams the logs to Elasticsearch. See [Logs supported by Fluentd](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/Fluentd-logs-supported.htm).
4748
- **Elasticsearch** - Elasticsearch is an open source, distributed, real-time search back-end. Elasticsearch stores the logs securely and offers an HTTP web interface for log analysis.
4849

4950
- **Kibana** - Kibana is used to visualize the logs stored in Elasticsearch. Kibana pulls the logs from Elasticsearch.
@@ -56,13 +57,13 @@ The EFK logging framework includes the following components:
5657

5758
### Features
5859

59-
The EFK logging framework provides the following features:
60+
The logging framework provides the following features:
6061

61-
- **Log collection and streaming** - Fluentd collects and streams the logs to Elasticsearch.
62+
- **Log collection and streaming** - FluentD collects and streams the logs to Elasticsearch.
6263

63-
- **Audit logs support** - Fluentd reads Kube-Apiserver audit logs from the Kubernetes master node and write those logs to Elasticsearch. The `auditlogEnabled` flag provided in fed-paas-helpers is used to enable/disable reading of audit logs. If the auditlogEnabled flag is set to true, then Fluentd is also deployed on the master node along with the worker nodes.
64+
- **Audit logs support** - FluentD reads Kube-Apiserver audit logs from the Kubernetes master node and write those logs to Elasticsearch. The `auditlogEnabled` flag provided in fed-paas-helpers is used to enable/disable reading of audit logs. If the auditlogEnabled flag is set to true, then FluentD is also deployed on the master node along with the worker nodes.
6465

65-
- **Event logging** - Fluentd creates a separate Elasticsearch index for all the event logs for a particular namespace. This helps to apply rules and search the event logs in a better way. The index starts with the prefix `fluentd-event`. All other regular debug logs go into a separate Elasticsearch index, prefixed with the string `fluentd-*`.
66+
- **Event logging** - FluentD creates a separate Elasticsearch index for all the event logs for a particular namespace. This helps to apply rules and search the event logs in a better way. The index starts with the prefix `fluentd-event`. All other regular debug logs go into a separate Elasticsearch index, prefixed with the string `fluentd-*`.
6667

6768
- **Log storage and analysis** - Elasticsearch securely stores the logs and offers a query language to search for and analyze the logs.
6869

@@ -80,12 +81,12 @@ This section describes the observability features (dashboards, statistics, logs,
8081

8182
#### Dashboards
8283

83-
EFK supports various dashboard options, including:
84+
Various dashboard are supported, including:
8485

8586
- Grafana dashboards (see [Logging framework dashboards](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/EFK_Dashboards.htm))
8687
- Kibana dashboards (see [Kibana dashboard overview](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/Kibana_Dashboards.htm))
8788
- Grafana Kibana dashboards (see [Kibana Grafana dashboards](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/kibana_grafana_dashboards.md.html))
88-
- Fluentd Operator dashboard (see [Fluentd operator Grafana dashboard](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/fluentd_operator_grafana_dashboards.md.html))
89+
- FluentD Operator dashboard (see [FluentD operator Grafana dashboard](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/fluentd_operator_grafana_dashboards.md.html))
8990
- Elasticsearch Grafana dashboard (see [Elasticsearch dashboard](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/elastic_grafana_dashboards.md.html))
9091

9192
#### Statistics
@@ -94,11 +95,11 @@ For information about supported statistics for EFK components, see:
9495

9596
- [Elasticsearch statistics](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/stats_ElasticSearch.htm)
9697
- [Other Elasticsearch statistics](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/cna-elastic-elastic-prom.md.html)
97-
- [Fluentd operator statistics](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/cna-fluentd_operator-fluentd-prom.md.html)
98+
- [FluentD operator statistics](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/cna-fluentd_operator-fluentd-prom.md.html)
9899

99100
For information about metrics-based alerts, see:
100101

101-
- [Fluentd operator metrics-based alerts](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/pod-fluentd_operator-metric_alert_rules.md.html)
102+
- [FluentD operator metrics-based alerts](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/pod-fluentd_operator-metric_alert_rules.md.html)
102103
- [Elastic metric-based alerts](https://manuals.metaswitch.com/UC/4.3.0/UnityCloud_Overview/Content/PaaS_Components/EFK_logging_FrameWork/pod-elastic-metric_alert_rules.md.html)
103104

104105
#### Events
@@ -107,7 +108,7 @@ For information about Elastic events, see [Elastic events](https://manuals.metas
107108

108109
#### Log visualization
109110

110-
The EFK framework aggregates logs from nodes and applications running inside your Azure Operator 5G Core installation. When logging is enabled, the EFK framework uses Fluentd to aggregate event logs from all applications and nodes into Elasticsearch. The EFK framework also provides a centralized Kibana web UI where users can view the logs or create rich visualizations and dashboards with the aggregated data.
111+
The framework aggregates logs from nodes and applications running inside your Azure Operator 5G Core installation. When logging is enabled, the EFK framework uses FluentD to aggregate event logs from all applications and nodes into Elasticsearch. The EFK framework also provides a centralized Kibana web UI where users can view the logs or create rich visualizations and dashboards with the aggregated data.
111112

112113
## Metrics framework
113114

@@ -127,7 +128,7 @@ The core components of the metrics framework are:
127128

128129
- **Prometheus server** - The Prometheus server collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and triggers alerts if certain conditions are true. Azure Operator 5G Core supports integration with the Prometheus server out of the box, with minimal required configuration.
129130
- **Client libraries** - Client libraries instrument the application code.
130-
- **Alertmanager** - Alertmanager handles alerts sent by client applications such as the Prometheus server. It handles deduplicating, grouping, and routing alerts to the correct receiver integrations (email, slack, etc.). Alertmanager also supports silencing and inhibition of alerts.
131+
- **AlertManager** - AlertManager handles alerts sent by client applications such as the Prometheus server. It handles deduplicating, grouping, and routing alerts to the correct receiver integrations (email, slack, etc.). AlertManager also supports silencing and inhibition of alerts.
131132
- **Grafana** - Grafana provides an out of the box set of dashboards rich with 3GPP and other KPIs to query, visualize, and understand the collected data.
132133
The Grafana audit feature provides a mechanism to restore or recreate dashboards in the Grafana server when Grafana server pod restarts. The audit feature also helps to delete any stale dashboards from the Grafana server.
133134

@@ -191,6 +192,8 @@ IstioHTTPRequestLatencyTooHigh: Requests are taking more than the <configured
191192
- **HTTPClientRespRcvd5xxPercentageTooHigh** - HTTP client response received with 5xx error and the received error percentage is more than the <configured_value> %.
192193
- **HTTPClientRespRcvd4xxPercentageTooHigh** - HTTP client response received with 4xx error and the received error percentage is more than the <configured_value> %.
193194

195+
## Tracing framework
196+
194197
#### Jaeger tracing with OpenTelemetry Protocol
195198

196199
Azure Operator 5G Core uses the OpenTelemetry Protocol (OTLP) in Jaeger tracing. OTLP replaces the Jaeger agent in fed-paas-helpers. Azure Operator 5G Core deploys the fed-otel_collector federation. The OpenTelemetry (OTEL) Collector runs as part of the fed-otel_collector namespace:
-26.7 KB
Loading
3.07 KB
Loading
-149 KB
Loading
-91.9 KB
Loading

articles/operator-5g-core/quickstart-subscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ Access is currently limited. For now, we're working with customers that have an
2020

2121
[What is Azure Operator 5G Core?](overview-product.md)
2222
[Deploy Azure Operator 5G Core](quickstart-deploy-5g-core.md)
23-
[Deployment order for clusters, network functions, and observability](concept-deployment-order.md)
23+
[Deployment order for clusters, network functions, and observability.](concept-deployment-order.md)

0 commit comments

Comments
 (0)