Skip to content

Commit a982ff1

Browse files
a-thalerNHingerl
andauthored
Apply suggestions from code review
Co-authored-by: Nina Hingerl <76950046+NHingerl@users.noreply.github.com>
1 parent 0d78a1f commit a982ff1

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

sap-cloud-logging/ship-logs.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Welcome to the first sample in our three-part series, where we will explore how Kyma can seamlessly integrate with the SAP Cloud Logging service. By enabling the three pillars of observability - logs, traces, and metrics - Kyma developers and operators can effectively troubleshoot issues, identify root causes, investigate performance bottlenecks, and gain a comprehensive understanding of system behavior.
44

5-
In this sample, we will delve into the following topics:
5+
This sample covers the following topics:
66

77
1. SAP Cloud Logging: An Overview
88
- Learn about the SAP Cloud Logging service and its significance in the context of Kyma integration.
@@ -11,7 +11,7 @@ In this sample, we will delve into the following topics:
1111
2. Shipping Logs to SAP Cloud Logging
1212
- Explore the step-by-step process of shipping logs from applications deployed on SAP BTP, Kyma runtime to SAP Cloud Logging.
1313

14-
In the subsequent samples, we will continue our exploration by discussing the integration of traces and metrics.
14+
The subsequent samples cover the integration of traces and metrics.
1515

1616
## What is SAP Cloud Logging?
1717

@@ -23,11 +23,11 @@ For Cloud Foundry and Kyma, SAP Cloud Logging offers an easy integration by prov
2323

2424
To get started with SAP Cloud Logging, visit the [Discovery Center](https://discovery-center.cloud.sap/serviceCatalog/cloud-logging?service_plan=overall-(large,-standard,-and-dev)&region=all&commercialModel=cloud&tab=feature) where you will find more detailed information about its features and capabilities.
2525

26-
Pricing for the SAP Cloud Logging service can be determined using the [SAP Cloud Logging Capacity Unit Estimator](https://sap-cloud-logging-estimator.cfapps.us10.hana.ondemand.com/). It is important to note that for Kyma, the "Ingest Otel" option needs to be enabled, which should be taken into account when estimating pricing. This option is used for shipping traces and metrics.
26+
To estimate pricing, use the [SAP Cloud Logging Capacity Unit Estimator](https://sap-cloud-logging-estimator.cfapps.us10.hana.ondemand.com/). For Kyma, you must enable the **Ingest Otel** option, which is used for shipping traces and metrics.
2727

2828
## Provision an Instance of SAP Cloud Logging
2929

30-
Now, let's explore how we can leverage SAP Cloud Logging to ingest logs from applications deployed on SAP BTP, Kyma runtime.
30+
Now, let's explore how we can use SAP Cloud Logging to ingest logs from applications deployed on SAP BTP, Kyma runtime.
3131

3232
### Prerequisites
3333

@@ -37,7 +37,8 @@ Now, let's explore how we can leverage SAP Cloud Logging to ingest logs from app
3737

3838
### Procedure
3939

40-
You can refer to the [official SAP documentation](https://help.sap.com/docs/cloud-logging/cloud-logging/create-sap-cloud-logging-instance-through-sap-btp-service-operator?version=Cloud) to create an SAP Cloud Logging service instance for details.
40+
For details, see [Create an SAP Cloud Logging Instance through SAP BTP Service Operator
41+
](https://help.sap.com/docs/cloud-logging/cloud-logging/create-sap-cloud-logging-instance-through-sap-btp-service-operator?version=Cloud).
4142

4243
- Export your namespace's name as an environment variable.
4344

@@ -97,7 +98,7 @@ The service binding also generates a Secret with the same name. It contains the
9798
9899
To ship your logs to SAP Cloud Logging, create LogPipeline custom resources (CRs).
99100
100-
Your application running in SAP BTP, Kyma runtime will send logs to stdout. The Telemetry module based on the LogPipeline will capture and ship them to SAP Cloud Logging.
101+
Your application running in SAP BTP, Kyma runtime sends logs to stdout. Based on the LogPipeline, the Telemetry module captures and ships them to SAP Cloud Logging.
101102
102103
### Create a LogPipeline CR for Your Application Logs
103104
@@ -118,35 +119,36 @@ This is an example of the LogPipeline configuration used for this sample:
118119

119120
![log-pipeline](./assets/log-pipeline.png)
120121

121-
### Enable Istio access logs
122+
### Enable Istio Access logs
122123

123-
Referred from [kyma-project.io documentation about istio access logs](https://kyma-project.io/external-content/telemetry-manager/docs/user/collecting-logs/istio-support.html).
124+
For details, see [Configure Istio Access Logs](https://kyma-project.io/external-content/telemetry-manager/docs/user/collecting-logs/istio-support.html).
124125

125-
Istio access logs provide fine-grained details about the traffic when accessing the workloads that are part of Istio service mesh. The only prerequisite is to enable Istio sidecar injection for your workloads. The Istio access logs provide useful information relating to 4 golden signals, such as latency, traffic, errors, and saturation as well as any troubleshooting anomalies.
126126

127-
[Configure Istio access logs for the entire mesh](https://kyma-project.io/external-content/telemetry-manager/docs/user/collecting-logs/istio-support.html#enable-istio-logs-for-the-entire-mesh)
127+
Istio access logs provide fine-grained details about traffic to workloads in the Istio service mesh, related to the four golden signals (latency, traffic, errors, and saturation) and help troubleshoot anomalies. Before you enable Istio access logs, enable Istio sidecar injection for your workloads.
128+
129+
For details, see [Enable Istio Logs for the Entire Mesh](https://kyma-project.io/external-content/telemetry-manager/docs/user/collecting-logs/istio-support.html#enable-istio-logs-for-the-entire-mesh).
128130

129131
```shell
130132
kubectl apply -f ./k8s/tracing/trace-istio-telemetry.yaml
131133
```
132134

133-
> Note: We use the same Istio telemetry configuration for tracing and logging.
135+
> **NOTE:** This and the subsequent samples use the same Istio Telemetry configuration for tracing and logging.
134136
135137
## View the logs
136138

137-
You can access the SAP Cloud Logging instance dashboard. The access details are available in the Secret generated by the service binding.
139+
To access the SAP Cloud Logging dashboard, use the credentials from the Secret generated by the service binding.
138140

139141
![cls-binding-secret](./assets/cls-binding-secret.png)
140142

141143
The simplest way to start exploring the logs is to navigate to **Discover** and choose the appropriate index.
142144

143145
![cls-access](./assets/cls-access.png)
144146

145-
You can choose the index pattern to view the relevant logs, apply a filter or search term to narrow down your search or use other Open Search capabilities.
147+
You can choose an index pattern to view relevant logs, apply a filter or search term to narrow down results, or use other OpenSearch capabilities.
146148

147149
![choose-index](./assets/choose-index.png)
148150

149-
We will talk more about metrics in one of the next samples. However, I would like to bring your attention to the Four Golden Signals dashboard. It is provided out of the box and is based on the Istio access logs which we configured previously.
151+
While metrics are covered in a later sample, note the **Four Golden Signals** dashboard. SAP Cloud Logging provides this dashboard out-of-the-box, based on the Istio access logs that you configured previously.
150152

151153
For reference, check out the generic and latency dashboards.
152154

0 commit comments

Comments
 (0)