Skip to content

Commit

Permalink
Update from SAP DITA CMS (squashed):
Browse files Browse the repository at this point in the history 
commit e3756ba9feb56a56de490e7f532b83273d573b54
Author: REDACTED
Date:   Thu May 16 23:53:25 2024 +0000

    Update from SAP DITA CMS 2024-05-16 23:53:24
    Project: dita-all/efq1693511418717
    Project map: 1131d7bc5f9e4befb4c774964fd0d5e0.ditamap
    Output: loio68fcd9805c5a481e8b2c606e0e36189c
    Language: en-US
    Builddable map: e351dd7d56bb4e6a9f5c497521540b50.ditamap

commit f9ec76a94adeee6974d75035c6bf4abaf3fcf25d
Author: REDACTED
Date:   Thu May 16 21:51:59 2024 +0000

    Update from SAP DITA CMS 2024-05-16 21:51:59
    Project: dita-all/efq1693511418717
    Project map: 1131d7bc5f9e4befb4c774964fd0d5e0.ditamap
    Output: loio68fcd9805c5a481e8b2c606e0e36189c
    Language: en-US
    Builddable map: e351dd7d56bb4e6a9f5c497521540b50.ditamap

commit 7fea5ef41ed23fc460ca8f42a97e5aa3f3b60a6c
Author: REDACTED
Date:   Fri May 10 21:52:07 2024 +0000

    Update from SAP DITA CMS 2024-05-10 21:52:07
    Project: dita-all/efq1693511418717
    Project map: 1131d7bc5f9e4befb4c774964fd0d5e0.ditamap
    Output: loio68fcd9805c5a481e8b2c606e0e36189c
    Language: en-US
    Builddable map: e351dd7d56bb4e6a9f5c497521540b50.ditamap

##################################################
[Remaining squash message was removed before commit...]
  • Loading branch information
@ditaccms-bot
ditaccms-bot committed May 17, 2024
1 parent 247f3f6 commit 0fca37b
Show file tree
Hide file tree
Showing 11 changed files with 338 additions and 169 deletions.
18 changes: 9 additions & 9 deletions docs/configuration-parameters-1830bca.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ Integer
</td>
<td valign="top">

Indirectly, this parameter sets the maximum disk size for storing observability data as described in [Service Plans](service-plans-a9d2d1b.md). This parameter has no effect for the `dev` plan. Needs to be between `2` and `10`. Default is `10`.
Indirectly, this parameter sets the maximum disk size for storing observability data as described in [Service Plans](service-plans-a9d2d1b.md). This parameter has no effect for the *dev* plan. Needs to be between `2` and `10`. Default is `10`.

</td>
</tr>
Expand Down Expand Up @@ -351,7 +351,7 @@ Integer
</td>
<td valign="top">

Specifies the maximum number of provisionable ingest instances, which are scaled automatically based on their overall CPU utilization. Must be between `2` and `10`. Defaults to `2`. This parameter impacts peak throughput and buffering. Scale-out happens when the overall CPU utilization exceeds 80%. Scale-in happens when the overall CPU utilization or configuration parameter decreases. This parameter has no effect on the `dev` plan, which is limited to a single instance.
Specifies the maximum number of provisionable ingest instances, which are scaled automatically based on their overall CPU utilization. Must be between `2` and `10`. Defaults to `2`. This parameter impacts peak throughput and buffering. Scale-out happens when the overall CPU utilization exceeds 80%. Scale-in happens when the overall CPU utilization or configuration parameter decreases. This parameter has no effect on the *dev* plan, which is limited to a single instance.

</td>
</tr>
Expand Down Expand Up @@ -486,7 +486,7 @@ String
</td>
<td valign="top">

The SAML group to grant administrative access and permissions to modify the security module. Required if `enabled` is set to `true`. Required if `enabled` is set to `true`.
The SAML group to grant administrative access and permissions to modify the security module. Required if `enabled` is set to `true`. Required if *enabled* is set to `true`.

</td>
</tr>
Expand All @@ -508,7 +508,7 @@ Boolean
</td>
<td valign="top">

Enables IdP-initiated SSO. Required if `enabled` is set to `true`.
Enables IdP-initiated SSO. Required if *enabled* is set to `true`.

</td>
</tr>
Expand All @@ -532,7 +532,7 @@ String

The list of backend\_roles will be read from this attribute during user login.

This field must be set to the corresponding attribute for IdP groups,usually `groups`. Required if `enabled` is set to `true`.
This field must be set to the corresponding attribute for IdP groups,usually `groups`. Required if *enabled* is set to `true`.

</td>
</tr>
Expand All @@ -554,7 +554,7 @@ URL
</td>
<td valign="top">

The URL to get the SAML IdP metadata from. Required if `enabled` is set to `true`.
The URL to get the SAML IdP metadata from. Required if *enabled* is set to `true`.

</td>
</tr>
Expand All @@ -578,7 +578,7 @@ String

The Entity ID of the SAML IdP.

Open the metadata URL in your browser and copy the full value of the `entityID` field. It is located in the first line of the response. Required if `enabled` is set to `true`.
Open the metadata URL in your browser and copy the full value of the `entityID` field. It is located in the first line of the response. Required if *enabled* is set to `true`.

</td>
</tr>
Expand All @@ -600,7 +600,7 @@ String
</td>
<td valign="top">

The Entity ID of the service provider. Generally, this parameter is set to the name of your application configured in your IdP. Required if `enabled` is set to `true`.
The Entity ID of the service provider. Generally, this parameter is set to the name of your application configured in your IdP. Required if *enabled* is set to `true`.

</td>
</tr>
Expand Down Expand Up @@ -666,7 +666,7 @@ String
</td>
<td valign="top">

Key to sign tokens. Provide a `random` key with an `even number (min. length: 32)` of `alphanumeric characters (A-Z, a-z, 0-9)`. A random key is generated if the key isn't provided.
Key to sign tokens. Provide a *random* key with an *even number \(min. length: 32\)* of *alphanumeric characters \(A-Z, a-z, 0-9\)*. A random key is generated if the key isn't provided.

</td>
</tr>
Expand Down
18 changes: 9 additions & 9 deletions docs/create-an-sap-cloud-logging-instance-through-sap-btp-cockpit-3aca7af.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ See [Prerequisites](prerequisites-41d8559.md).

To create an SAP Cloud Logging instance using the SAP BTP Cockpit, follow these steps:

1. Open the SAP BTP Cockpit and navigate to the `Instances and Subscriptions` page of your subaccount.
2. Click `Create`.
1. Open the SAP BTP Cockpit and navigate to the *Instances and Subscriptions* page of your subaccount.
2. Click *Create*.
3. Configure your Instance:
- Select `cloud-logging service`.
- Select *cloud-logging service*.
- Select your preferred service plan \(see [Service Plans](service-plans-a9d2d1b.md)\).
- Set an `Instance Name`.
- Set an *Instance Name*.

4. Configure `Service Configuration Parameters` \(see [Configuration Parameters](configuration-parameters-1830bca.md)\)
5. Review and click `Create`. It takes some time until SAP Cloud Logging is up.
4. Configure *Service Configuration Parameters* \(see [Configuration Parameters](configuration-parameters-1830bca.md)\)
5. Review and click *Create*. It takes some time until SAP Cloud Logging is up.



Expand All @@ -38,7 +38,7 @@ To create an SAP Cloud Logging instance using the SAP BTP Cockpit, follow these

Get a service key to access instance credentials.

1. Select your SAP Cloud Logging instance to open the `Bindings` panel and click `Create`.
2. Enter a name for the binding and click `Create`.
3. Click the three dots next to the newly created binding and select `View` to show the credentials of the service instance.
1. Select your SAP Cloud Logging instance to open the *Bindings* panel and click *Create*.
2. Enter a name for the binding and click *Create*.
3. Click the three dots next to the newly created binding and select *View* to show the credentials of the service instance.

2 changes: 1 addition & 1 deletion ...reate-an-sap-cloud-logging-instance-through-sap-btp-service-operator-f6aa131.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ This step results in a `secret` with the name `cls``sap-cloud-logging-integratio
```
We recommend you enable [credentials rotation](https://github.com/SAP/sap-btp-service-operator/blob/main/README.md#credentials-rotation) for the ServiceBinding, so that the configuration is updated automatically. Assure that the `rotationFrequency` binding parameter reflects a period of more than a day to avoid frequent restarts.
We recommend you enable [credentials rotation](https://github.com/SAP/sap-btp-service-operator/blob/main/README.md#credentials-rotation) for the ServiceBinding, so that the configuration is updated automatically. Assure that the *rotationFrequency* binding parameter reflects a period of more than a day to avoid frequent restarts.
The binding creation automatically triggers the creation of a `secret` with the name `sap-cloud-logging` in in the same namespace.
Expand Down
3 changes: 2 additions & 1 deletion docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ SAP Cloud Logging service is an instance-based and environment-agnostic observab
- [Create an SAP Cloud Logging Instance through SAP BTP CLI](create-an-sap-cloud-logging-instance-through-sap-btp-cli-21eb1bd.md)
- [Create an SAP Cloud Logging Instance through SAP BTP Service Operator](create-an-sap-cloud-logging-instance-through-sap-btp-service-operator-f6aa131.md)
- [Ingest Observability Data](ingest-observability-data-ba16ff7.md)
- [Ingest via Cloud Foundry Runtime](ingest-via-cloud-foundry-runtime-f5a7c99.md)
- [Ingest from Cloud Foundry Runtime](ingest-from-cloud-foundry-runtime-f5a7c99.md)
- [Ingest via Kyma Runtime](ingest-via-kyma-runtime-612c7b9.md)
- [Ingest via OpenTelemetry API Endpoint](ingest-via-opentelemetry-api-endpoint-fdc78af.md)
- [Ingest via JSON API Endpoint](ingest-via-json-api-endpoint-3416f8f.md)
- [Rotate the Ingestion Root CA Certificate](rotate-the-ingestion-root-ca-certificate-bbcb3e7.md)
- [Access and Analyze Observability Data](access-and-analyze-observability-data-dad5b01.md)
- [Data Protection and Privacy](data-protection-and-privacy-80e76fd.md)
Expand Down
129 changes: 129 additions & 0 deletions docs/ingest-from-cloud-foundry-runtime-f5a7c99.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
<!-- loiof5a7c993743c4ee79722479371b90b37 -->

# Ingest from Cloud Foundry Runtime

Shipping logs from applications deployed on SAP BTP Cloud Foundry can be configured in different ways. Even without any specific application logs, you can analyze your applications based on the automatically issued request logs from the Cloud Foundry router. Further, you can benefit from default contents, such as dashboards, index patterns, and retention settings.



> ### Note:
> You can also [Ingest via OpenTelemetry API Endpoint](ingest-via-opentelemetry-api-endpoint-fdc78af.md).
> ### Caution:
> Ensure that you consider [SAP BTP Security Recommendation BTP-CLS-0002](https://help.sap.com/docs/btp/sap-btp-security-recommendations-c8a9bb59fe624f0981efa0eff2497d7d/sap-btp-security-recommendations?seclist-index=BTP-CLS-0002).
All configuration steps can be done either using SAP BTP Cockpit or the Cloud Foundry Command Line Interface.



<a name="loiof5a7c993743c4ee79722479371b90b37__section_fbf_yc4_xyb"/>

## Procedures

Shipping logs from applications deployed on SAP BTP Cloud Foundry can be configured using one of the below options:

- [Bind the Application to the Service Instance](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__bind_the_application), optionally using [Share Service Instance Across Different Spaces](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__share_service_instance_across_different_spaces) to consolidate observability data across spaces within one organization.
- [Bind the Application to a User Provided Service](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__bind_the_application_to_user_provided_service).
- We recommend you use one of the Cloud Foundry open source logging libraries \([Java](https://github.com/SAP/cf-java-logging-support)/[NodeJS](https://github.com/SAP/cf-nodejs-logging-support)\) to configure logging within your application.



### Bind the Application to the Service Instance

**Bind the Application Using the Command Line Interface**

1. [Log On to the Cloud Foundry Environment Using the Cloud Foundry Command Line Interface](https://help.sap.com/docs/btp/sap-business-technology-platform/log-on-to-cloud-foundry-environment-using-cloud-foundry-command-line-interface).
2. To bind the application via command line interface, execute the following command:

```
cf bind-service <app-name> <service-instance>
```
> ### Note:
> Although the command line interface prompts you to restage the app, the binding takes effect without restaging.
3. Go to the [Result](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__section_gvg_4k4_xyb) section.
**Bind the Application Using the SAP BTP Cockpit**
1. [Log On to the Cloud Foundry Environment Using the SAP BTP Cockpit](https://help.sap.com/docs/btp/sap-business-technology-platform/cloud-foundry-environment).
2. Execute [Bind Service Instances to Applications Using the Cockpit](https://help.sap.com/docs/service-manager/sap-service-manager/binding-service-instances-to-cloud-foundry-applications) without binding parameters.
3. Go to the [Result](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__section_gvg_4k4_xyb) section.
### Share Service Instance Across Different Spaces
You can share a single service instance across multiple spaces. Skip this step if you don't need to share a single instance across multiple spaces of the same org.
1. [Log on to the Cloud Foundry Environment Using the Cloud Foundry Command Line Interface](https://help.sap.com/docs/btp/sap-business-technology-platform/log-on-to-cloud-foundry-environment-using-cloud-foundry-command-line-interface).
2. To share the services in an additional space, execute the following command:
```
cf share-service <service-instance> -s <other-space>
```
3. Go to the [Result](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__section_gvg_4k4_xyb) section.
> ### Note:
> Be careful when deleting service keys. Credentials are invalidated if the service key is deleted, and there is no automated mechanism to track in which user provided services instances the information of a service key is used.
### Bind the Application to a User Provided Service
[Bind the Application to the Service Instance](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__bind_the_application) is the recommended approach, because of simplicity in setup and maintenance. Introducing an indirection via service key and [binding to a user-provided service](https://docs.cloudfoundry.org/devguide/services/user-provided.html) to send logs is only advisable:
- to reduce the dependency on bind operations in automated procedures.
- to ingest across Cloud Foundry orgs to a single Cloud Logging instance.
**Bind the Application to User Provided Service Using the Command Line Interface**
1. [Log on to the Cloud Foundry Environment Using the Cloud Foundry Command Line Interface](https://help.sap.com/docs/btp/sap-business-technology-platform/log-on-to-cloud-foundry-environment-using-cloud-foundry-command-line-interface).
2. Execute the following command to list the service instances:
```
cf services
```
3. Execute the following command to create a service key without binding to any application:
```
cf create-service-key <service-instance> <service-key>
```
4. Extract `ingest-endpoint`, `ingest-username`, and `ingest-password` from the response of executing:
```
cf service-key <service-instance> <service-key>
```
5. Create a user provided service using the following the template filled with the values of the previous step and a user-provided-service-name of your choice:
```
cf cups <user-provided-service-name> -l https://<ingest-username>:<ingest-password>@<ingest-endpoint>/cfsyslog
```
6. Proceed with [Bind the Application to the Service Instance](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__bind_the_application) and bind to the user provided service.
**Bind the Application to User Provided Service Using SAP BTP Cockpit**
1. [Log On to the Cloud Foundry Environment Using the SAP BTP Cockpit](https://help.sap.com/docs/btp/sap-business-technology-platform/cloud-foundry-environment).
2. Create a service key according to [Creating Service Keys in Cloud Foundry](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/6fcac08409db4b0f9ad55a6acd4d31c5.html).
3. Create a User-Provided Service following [Creating User-Provided Service Instances in Cloud Foundry Environment](https://help.sap.com/docs/service-manager/sap-service-manager/creating-user-provided-service-instances-in-cloud-foundry-environment) using `Instance Name` of your choice and the information from the the service key to configure `System Logs Drain URL`:
```
https://<ingest-username>:<ingest-password>@<ingest-endpoint>/cfsyslog
```
4. Proceed with [Bind the Application to the Service Instance](ingest-from-cloud-foundry-runtime-f5a7c99.md#loiof5a7c993743c4ee79722479371b90b37__bind_the_application) and bind to the user provided service.
<a name="loiof5a7c993743c4ee79722479371b90b37__section_gvg_4k4_xyb"/>
## Result
The ingested data can be analyzed in OpenSearch Dashboards \(see [Access and Analyze Observability Data](access-and-analyze-observability-data-dad5b01.md)\) based on the `logs-cfsyslog-*` index pattern.
3 changes: 2 additions & 1 deletion docs/ingest-observability-data-ba16ff7.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@

Use one or more of the following options to drain observability data in your Cloud Logging instance.

- [Ingest via Cloud Foundry Runtime](ingest-via-cloud-foundry-runtime-f5a7c99.md)
- [Ingest from Cloud Foundry Runtime](ingest-from-cloud-foundry-runtime-f5a7c99.md)
- [Ingest via Kyma Runtime](ingest-via-kyma-runtime-612c7b9.md)
- Ship via API
- [Ingest via OpenTelemetry API Endpoint](ingest-via-opentelemetry-api-endpoint-fdc78af.md)

- [Ingest via JSON API Endpoint](ingest-via-json-api-endpoint-3416f8f.md)
- [Rotate the Ingestion Root CA Certificate](rotate-the-ingestion-root-ca-certificate-bbcb3e7.md)

Loading

0 comments on commit 0fca37b

Please sign in to comment.