Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
a-thaler committed Oct 8, 2024
1 parent 22d1e83 commit eea4355
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
14 changes: 7 additions & 7 deletions docs/user/04-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ spec:
> The Metric agent can scrape endpoints even if the workload is a part of the Istio service mesh and accepts mTLS communication. However, there's a constraint: For scraping through HTTPS, Istio must configure the workload using 'STRICT' mTLS mode. Without 'STRICT' mTLS mode, you can set up scraping through HTTP by applying the annotation `prometheus.io/scheme=http`. For related troubleshooting, see [Log entry: Failed to scrape Prometheus endpoint](#log-entry-failed-to-scrape-prometheus-endpoint).


### 4. Default Metrics for Telemetry Health
### 5. Default Metrics for Telemetry Health
By default, a MetricPipeline emits metrics about the health of all pipelines managed by the Telemetry module. Based on these metrics, you can track the status of every individual pipeline and set up alerting for it. The following metrics are emitted for every pipeline and the Telemetry module itself:

| Metric | Description | Availability |
Expand All @@ -371,7 +371,7 @@ A typical alert rule looks like the following example. The alert is triggered if
```


### 5. Activate Runtime Metrics
### 6. Activate Runtime Metrics

To enable collection of runtime metrics, define a MetricPipeline that has the `runtime` section enabled as input:

Expand Down Expand Up @@ -465,7 +465,7 @@ If Node metrics are enabled, the following metrics are collected:
- `k8s.node.network.io`


### 6. Activate Istio Metrics
### 7. Activate Istio Metrics

To enable collection of Istio metrics, define a MetricPipeline that has the `istio` section enabled as input:

Expand All @@ -486,7 +486,7 @@ spec:

With this, the agent starts collecting all Istio metrics from Istio sidecars.

### 7. Deactivate OTLP Metrics
### 8. Deactivate OTLP Metrics

By default, `otlp` input is enabled.

Expand All @@ -511,7 +511,7 @@ spec:

With this, the agent starts collecting all Istio metrics from Istio sidecars, and the push-based OTLP metrics are dropped.

### 8. Add Filters
### 9. Add Filters

To filter metrics by namespaces, define a MetricPipeline that has the `namespaces` section defined in one of the inputs. For example, you can specify the namespaces from which metrics are collected or the namespaces from which metrics are dropped. Learn more about the available [parameters and attributes](resources/05-metricpipeline.md).

Expand Down Expand Up @@ -564,7 +564,7 @@ spec:
>
> However, if the namespace selector is not defined for the `istio` and `otlp` input, then metrics from system namespaces are included by default.

### 9. Activate Diagnostic Metrics
### 10. Activate Diagnostic Metrics

If you use the `prometheus` or `istio` input, for every metric source typical scrape metrics are produced, such as `up`, `scrape_duration_seconds`, `scrape_samples_scraped`, `scrape_samples_post_metric_relabeling`, and `scrape_series_added`.

Expand Down Expand Up @@ -613,7 +613,7 @@ If you want to use them for debugging and diagnostic purposes, you can activate
> [!NOTE]
> Diagnostic metrics are only available for inputs `prometheus` and `istio`. Learn more about the available [parameters and attributes](resources/05-metricpipeline.md).

### 10. Deploy the Pipeline
### 11. Deploy the Pipeline

To activate the MetricPipeline, apply the `metricpipeline.yaml` resource file in your cluster:

Expand Down
4 changes: 3 additions & 1 deletion docs/user/integration/sap-cloud-logging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ Learn how to define and import recommended alerts for SAP Cloud Logging. The fol
| Kyma Telemetry Integration | [Access log ingestion](https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/alert-access-log-ingestion.json) | The LogPipeline for shipping [access logs](#ship-logs-to-sap-cloud-logging) might lose connectivity to SAP Cloud Logging, with the effect that no access logs are ingested anymore. |
| Kyma Telemetry Integration | [Trace ingestion](https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/alert-trace-ingestion.json) | The TracePipeline for shipping [traces](#ship-distributed-traces-to-sap-cloud-logging) might lose connectivity to SAP Cloud Logging, with the effect that no traces are ingested anymore. |
| Kyma Telemetry Integration | [Metric ingestion](https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/alert-metric-ingestion.json) | The MetricPipeline for shipping [metrics](#ship-metrics-to-sap-cloud-logging) might lose connectivity to SAP Cloud Logging, with the effect that no metrics are ingested anymore. |
| Kyma Telemetry Integration | [Kyma Telemetry Status](https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/alert-telemetry-status.json) | The Telemetry module might report a non-ready state indicating a configuration or data flow problem. |
| Kyma Telemetry Integration | <!-- markdown-link-check-disable-next-line -->[Kyma Telemetry Status](https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/alert-telemetry-status.json) | The Telemetry module might report a non-ready state indicating a configuration or data flow problem. |
5. Edit notification action: Add the `destination` and adjust the intervals and thresholds to your needs.
6. Verify that the new monitor definition is listed among the SAP Cloud Logging alerts.
Expand All @@ -320,9 +320,11 @@ Learn how to define and import recommended alerts for SAP Cloud Logging. The fol
You can view logs, traces, and metrics in SAP Cloud Logging dashboards:
<!-- markdown-link-check-disable -->
- To view the traffic and application logs, use the SAP Cloud Logging dashboards prefixed with `Kyma_`, which are based on both kinds of log ingestion: application and access logs.
- To view distributed traces, use the OpenSearch plugin **Observability**.
- To view the container- and Pod-related metrics collected by the MetricPipeline `runtime` input, use the dashboard **[OTel] K8s Container Metrics**.
- To view the Node-related metrics collected by the MetricPipeline `runtime` input, manually import the file [K8s Nodes](https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/dashboard-nodes.ndjson).
- To view the status of the Cloud Logging integration via the Kyma Telemetry module, manually import the file [Kyma Telemetry Status](https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/dashboard-status.ndjson).
- To use the dashboard for Istio metrics of Pods that have an active Istio sidecar injection (collected by the MetricPipeline `istio` input), manually import the file [Kyma Istio Service Metrics](https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/dashboard-istio.ndjson).
<!-- markdown-link-check-enable -->

0 comments on commit eea4355

Please sign in to comment.