Skip to content

Commit 65d5b38

Browse files
SUMO-251067 | Apoorv | Add. PR review comments
1 parent c646862 commit 65d5b38

File tree

6 files changed

+32
-45
lines changed

6 files changed

+32
-45
lines changed

docs/integrations/app-development/bitbucket.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,6 @@ In this step, you configure a Hosted Collector to receive Webhook Events from Bi
125125
8. **Triggers** - Click on Choose from a full list of triggers, and choose all triggers under Repository, Issue and Pull Request.
126126
9. Click **Save**
127127

128-
129128
### Step 3: Configure the Bitbucket CI/CD Pipeline to Collect Deploy Events
130129

131130
A Bitbucket pipe needs to be configured to send code deploy status to Sumo Logic. Add the following pipe code to the step section of your deployment part of the `bitbucket-pipelines.yml` file. Replace `SUMOLOGIC_HTTP_URL` with HTTP Source URL configured in Step 1.
@@ -141,12 +140,9 @@ If you want to deployment events to multiple Sumo Logic orgs, include a `-pipe`
141140

142141
For reference: This is how the [bitbucket-pipelines.yml](https://bitbucket.org/app-dev-sumo/backendservice/src/master/bitbucket-pipelines.yml) looks after adding deploy pipe code to our sample Bitbucket CI/CD pipeline.
143142

144-
145143
### Step 4: Enable Bitbucket Event-Key tagging at Sumo Logic
146144

147-
Sumo Logic needs to understand the event type for incoming events (for example, repo:push events). To enable this, the [X-Event-Key](https://confluence.atlassian.com/bitbucket/event-payloads-740262817.html#EventPayloads-HTTPheaders) event type is automatically added to the [Fields](/docs/manage/fields) during installation of the app.
148-
149-
145+
To properly identify the event type for incoming events (for example, repo:push events), Sumo Logic automatically adds the [X-Event-Key](https://confluence.atlassian.com/bitbucket/event-payloads-740262817.html#EventPayloads-HTTPheaders) event type to the [Fields](/docs/manage/fields) during app installation.
150146

151147
## Installing the Bitbucket App
152148

docs/integrations/app-development/github.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,7 @@ To configure a GitHub Webhook:
158158

159159
### Enable GitHub Event tagging at Sumo Logic
160160

161-
Sumo Logic needs to understand the event type for incoming events. To enable this, the [x-github-event](https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads) event type is automatically added to the [Fields](/docs/manage/fields) during installation of the app.
162-
161+
To properly identify the event type for incoming events, Sumo Logic automatically adds the [x-github-event](https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads) event type to the [Fields](/docs/manage/fields) during app installation.
163162

164163
## Installing the GitHub App
165164

docs/integrations/app-development/gitlab.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,7 @@ Refer to the [GitLab Webhooks documentation](https://docs.gitlab.com/ee/user/pro
9393

9494
### Step 3: Enable GitLab Event tagging at Sumo Logic
9595

96-
Sumo Logic needs to understand the event type for incoming events. To enable this, the [x-gitlab-event](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html#push-events) event type is automatically added to the [Fields](/docs/manage/fields) during installation of the app.
97-
98-
96+
To properly identify the event type for incoming events, Sumo Logic automatically adds the [x-gitlab-event](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html#push-events) event type to the [Fields](/docs/manage/fields) during app installation.
9997

10098
## Installing the GitLab App
10199

docs/integrations/containers-orchestration/activemq.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,25 +51,23 @@ Host: broker-3-activemq Name: /opt/activemq/data/activemq.log Category:logfile
5151
This App has been tested with following ActiveMQ versions:
5252
* 5.16.2.
5353

54-
Configuring log and metric collection for the ActiveMQ App includes the following tasks:
54+
### Step 1: Configure fields in Sumo Logic
5555

56-
### Step 1: Fields in Sumo Logic
56+
Configuring log and metric collection for the ActiveMQ App includes the following tasks:
5757

5858
The following [fields](/docs/manage/fields/) will always be created automatically as a part of the app installation process:
59-
60-
* `pod_labels_component`
61-
* `pod_labels_environment`
62-
* `pod_labels_messaging_system`
63-
* `pod_labels_messaging_cluster`
64-
65-
66-
If you're using ActiveMQ in a non-Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
6759
* `component`
6860
* `environment`
6961
* `messaging_system`
7062
* `messaging_cluster`
7163
* `pod`
7264

65+
If you're using ActiveMQ in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
66+
* `pod_labels_component`
67+
* `pod_labels_environment`
68+
* `pod_labels_messaging_system`
69+
* `pod_labels_messaging_cluster`
70+
7371
For information on setting up fields, see [Fields](/docs/manage/fields).
7472

7573

@@ -250,7 +248,7 @@ This section explains the steps to collect ActiveMQ logs from a Kubernetes envir
250248
annotations:
251249
tailing-sidecar: sidecarconfig;data:/opt/activemq/data/activemq.log
252250
```
253-
1. Make sure that the ActiveMQ pods are running and annotations are applied by using the command:
251+
1. Ensure that the ActiveMQ pods are running and annotations are applied by using the command:
254252
```bash
255253
kubectl describe pod <ActiveMQ_pod_name>
256254
```
@@ -427,7 +425,7 @@ At this point, ActiveMQ logs should start flowing into Sumo Logic.
427425
import CreateMonitors from '../../reuse/apps/create-monitors.md';
428426

429427
<CreateMonitors/>
430-
There are limits to how many alerts can be enabled
428+
There are limits to how many alerts can be enabled.
431429

432430
:::note permissions required
433431
To install these monitors, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).

docs/integrations/containers-orchestration/kafka.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,21 @@ messaging_cluster=* messaging_system="kafka" \
6767

6868
This section provides instructions for configuring log and metric collection for the Sumo Logic App for Kafka.
6969

70-
### Fields in Sumo Logic
70+
### Step 1: Configure fields in Sumo Logic
7171

72-
The following [fields](https://help.sumologic.com/docs/manage/fields/) will always be created automatically as a part of the app installation process:
73-
74-
* `pod_labels_component`
75-
* `pod_labels_environment`
76-
* `pod_labels_messaging_system`
77-
* `pod_labels_messaging_cluster`
78-
79-
80-
If you're using Kafka in a non-Kubernetes environment, these additional fields will get created automatically as a part of the app installation process:
72+
The following [fields](/docs/manage/fields/) will always be created automatically as a part of the app installation process:
8173
* `component`
8274
* `environment`
8375
* `messaging_system`
8476
* `messaging_cluster`
8577
* `pod`
8678

79+
If you're using Kafka in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
80+
* `pod_labels_component`
81+
* `pod_labels_environment`
82+
* `pod_labels_messaging_system`
83+
* `pod_labels_messaging_cluster`
84+
8785
For information on setting up fields, see [Fields](/docs/manage/fields).
8886

8987
### Configure Collection for Kafka
@@ -216,7 +214,7 @@ This section explains the steps to collect Kafka logs from a Kubernetes environm
216214
kubectl describe pod <Kafka_pod_name>
217215
```
218216
5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
219-
3. **FER to normalize the fields in Kubernetes environments**. Labels created in Kubernetes environments automatically are prefixed with `pod_labels`. To normalize these for our app to work, a Field Extraction Rule is automatically created named **AppObservabilityMessagingKafkaFER**
217+
3. **FER to normalize the fields in Kubernetes environments**. Labels created in Kubernetes environments automatically are prefixed with `pod_labels`. To normalize these for our app to work, a Field Extraction Rule named **AppObservabilityMessagingKafkaFER** is automatically created.
220218

221219
</TabItem>
222220
<TabItem value="non-k8s">

docs/integrations/containers-orchestration/rabbitmq.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,24 +50,22 @@ Host: broker-1 Name: /var/log/rabbitmq/rabbit.log Category: logfile
5050

5151
This section provides instructions for configuring log and metric collection for the Sumo Logic App for RabbitMQ.
5252

53+
### Step 1: Configure fields in Sumo Logic
5354

54-
### Step 1: Fields in Sumo Logic
55-
56-
The following [fields](https://help.sumologic.com/docs/manage/fields/) will always be created automatically as a part of the app installation process:
57-
58-
* `pod_labels_component`
59-
* `pod_labels_environment`
60-
* `pod_labels_messaging_system`
61-
* `pod_labels_messaging_cluster`
62-
63-
If you're using RabbitMQ in a non-Kubernetes environment, these additional fields will get created automatically as a part of the app installation process:
55+
The following [fields](/docs/manage/fields/) will always be created automatically as a part of the app installation process:
6456
* `component`
6557
* `environment`
6658
* `messaging_system`
6759
* `messaging_cluster`
6860
* `pod`
6961

70-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
62+
If you're using RabbitMQ in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
63+
* `pod_labels_component`
64+
* `pod_labels_environment`
65+
* `pod_labels_messaging_system`
66+
* `pod_labels_messaging_cluster`
67+
68+
For information on setting up fields, see [Fields](/docs/manage/fields).
7169

7270
### Step 2: Configure Collection for RabbitMQ
7371

@@ -195,7 +193,7 @@ For all other parameters see [this doc](/docs/send-data/collect-from-other-data-
195193
kubectl describe pod <RabbitMQ_pod_name>
196194
```
197195
5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
198-
3. **FER to normalize the fields in Kubernetes environments**. Labels created in Kubernetes environments automatically are prefixed with `pod_labels`. To normalize these for our app to work, a Field Extraction Rule is automatically created named **AppObservabilityMessagingRabbitMQFER**
196+
3. **FER to normalize the fields in Kubernetes environments**. Labels created in Kubernetes environments automatically are prefixed with `pod_labels`. To normalize these for our app to work, a Field Extraction Rule named **AppObservabilityMessagingRabbitMQFER** is automatically created.
199197

200198
</TabItem>
201199
<TabItem value="non-k8s">

0 commit comments

Comments
 (0)