Skip to content

Commit edcfccf

Browse files
kimsaucechetanchoudhary-sumojpipkin1amee-sumo
authored
Remove hard-coded links, formatting edits (#5738)
* Adding OpenTelemetry Monitoring App docs * updating monitor details * updating filename, adding sidebar * Updating s3 links for screenshots * Updates from review * adding form screenshot, made few updates * Implementing more feedbacks * Updates * Update cid-redirects.json * release note and product list * Remove hard-coded links, formatting edits * Update docs/integrations/sumo-apps/opentelemetry-collector-insights.md * Update docs/integrations/sumo-apps/opentelemetry-collector-insights.md * Update docs/integrations/google/cloud-security-command-center.md * Update docs/integrations/google/cloud-security-command-center.md * Update docs/integrations/google/cloud-security-command-center.md * Update docs/integrations/sumo-apps/opentelemetry-collector-insights.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/google/cloud-security-command-center.md * Update docs/integrations/google/cloud-security-command-center.md * Update docs/integrations/sumo-apps/opentelemetry-collector-insights.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> --------- Co-authored-by: chetanchoudhary-sumo <[email protected]> Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> Co-authored-by: Amee Lepcha <[email protected]>
1 parent ff4f633 commit edcfccf

File tree

2 files changed

+19
-22
lines changed

2 files changed

+19
-22
lines changed

docs/integrations/google/cloud-security-command-center.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -468,8 +468,8 @@ This section describes the Sumo Logic pipeline for collecting the data from Goog
468468
Follow the steps below to integrate the Google Cloud Security Command Center (SCC) app:
469469

470470
1. Enable the [Security Command Center (SCC)](https://cloud.google.com/security-command-center/docs/activate-scc-overview) at the GCP console.
471-
1. In Sumo Logic, [configure the Google Cloud Platform source](https://help.sumologic.com/docs/send-data/hosted-collectors/google-source/google-cloud-platform-source/#configure-agoogle-cloud-platform-source).
472-
1. In the GCP console, configure a Pub/Sub Topic for [GCP](https://help.sumologic.com/docs/send-data/hosted-collectors/google-source/google-cloud-platform-source/#configure-a-pubsub-topicfor-gcp). This topic will be used to send SCC findings from GCP to Sumo Logic.
471+
1. In Sumo Logic, [configure the Google Cloud Platform source](/docs/send-data/hosted-collectors/google-source/google-cloud-platform-source/#configure-agoogle-cloud-platform-source).
472+
1. In the GCP console, configure a Pub/Sub Topic for [GCP](/docs/send-data/hosted-collectors/google-source/google-cloud-platform-source/#configure-a-pubsub-topicfor-gcp). This topic will be used to send SCC findings from GCP to Sumo Logic.
473473
1. In the SCC blade of the GCP console, click **Continuous Exports**. <br/><img src={useBaseUrl('https://sumologic-app-data-v2.s3.us-east-1.amazonaws.com/dashboards/Google+Cloud+-+Security+Command+Center/step4.png')} alt="Google Cloud Storage dashboards" width="500" />
474474
1. In the GCP console, export the findings from SCC to the [Pub/Sub Topic](https://cloud.google.com/security-command-center/docs/how-to-export-data?_gl=1*1dt4zsw*_ga*ODU1MTc4OTQ1LjE3Mzg3ODM5NzI.*_ga_WH2QY8WWF5*czE3NDY2Mzc3MzQkbzMkZzEkdDE3NDY2MzgxNDUkajYwJGwwJGgw#configure-pubsub-exports) created above.
475475

docs/integrations/sumo-apps/opentelemetry-collector-insights.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,8 @@ Following are the [fields](/docs/manage/fields/) which will be created as part o
2929

3030
### For OTLP endpoint configuration
3131

32-
Before configuring the OTEL Collector integration, ensure you have the following prerequisites in place:
3332

34-
1. **Sumo Logic OTLP Source**: You need to create an OTLP source in your Sumo Logic hosted collector. The OTLP source will provide the endpoint URL that the OTEL Collector will use to send telemetry data.
35-
36-
**Documentation**: [Creating a Sumo Logic OTLP Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/otlp/)
33+
Before configuring the OTEL Collector integration, you need to create an OTLP source in your Sumo Logic hosted collector. The OTLP source will provide the endpoint URL that the OTEL Collector will use to send telemetry data. Learn more at [Creating a Sumo Logic OTLP Source](/docs/send-data/hosted-collectors/http-source/otlp/).
3734

3835
### For metrics collection
3936

@@ -77,7 +74,7 @@ In this step, you will configure the OpenTelemetry Collector's built-in telemetr
7774

7875
Below are the inputs required:
7976

80-
- **OTLP Endpoint**: Your Sumo Logic OTLP endpoint URL.
77+
- **OTLP Endpoint**. Your Sumo Logic OTLP endpoint URL.
8178

8279

8380
```yaml
@@ -107,13 +104,13 @@ service:
107104
deployment.environment: ${DEPLOYMENT_ENVIRONMENT}
108105
```
109106
110-
You can add any custom fields which you want to tag along with the data ingested in Sumo.
107+
You can add any custom fields which you want to tag along with the data ingested in Sumo Logic.
111108
112109
import EnvVar from '../../reuse/apps/opentelemetry/env-var-required.md';
113110
114111
<EnvVar/>
115112
116-
<img src='https://sumologic-app-data-v2.s3.us-east-1.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/opentelemetry-collector-insights-configure-form.png' style={{border:'1px solid gray'}} alt="YAML" />
113+
<img src='https://sumologic-app-data-v2.s3.us-east-1.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/opentelemetry-collector-insights-configure-form.png' style={{border:'1px solid gray'}} alt="YAML" width="700"/>
117114
118115
### Step 3: Send logs and metrics to Sumo Logic
119116
@@ -137,31 +134,31 @@ import LogsIntro from '../../reuse/apps/opentelemetry/send-logs-intro.md';
137134
138135
1. Add the telemetry configuration to your existing collector configuration file in `/etc/otelcol-sumo/conf.d/` or directly in the main configuration file.
139136
2. Place Env file in the following directory:
140-
```sh
141-
/etc/otelcol-sumo/env/
142-
```
137+
```sh
138+
/etc/otelcol-sumo/env/
139+
```
143140
3. Restart the collector using:
144-
```sh
145-
sudo systemctl restart otelcol-sumo
146-
```
141+
```sh
142+
sudo systemctl restart otelcol-sumo
143+
```
147144

148145
</TabItem>
149146
<TabItem value="Windows">
150147

151148
1. Add the telemetry configuration to your existing collector configuration file in `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` or the main configuration file.
152149
2. Restart the collector using:
153-
```sh
154-
Restart-Service -Name OtelcolSumo
155-
```
150+
```sh
151+
Restart-Service -Name OtelcolSumo
152+
```
156153

157154
</TabItem>
158155
<TabItem value="macOS">
159156

160157
1. Add the telemetry configuration to your existing collector configuration file in `/etc/otelcol-sumo/conf.d/` or the main configuration file.
161158
2. Restart the otelcol-sumo process using:
162-
```sh
163-
otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"
164-
```
159+
```sh
160+
otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"
161+
```
165162

166163
</TabItem>
167164
<TabItem value="Chef">
@@ -419,4 +416,4 @@ import CreateMonitors from '../../reuse/apps/create-monitors.md';
419416
| `OpenTelemetry Collector Insights - Collector Instance is Down` | This alert fires when a Collector instance stops sending telemetry for more than 10 minutes, indicating it is down or has a connectivity issue. | Missing Data | Data Found |
420417
| `OpenTelemetry Collector Insights - Exporter Queue Nearing Capacity` | This alert fires when an exporter's sending queue is over 90% full. This is a strong leading indicator of back pressure and imminent data loss. | Count > = 90 | Count < 90 |
421418
| `OpenTelemetry Collector Insights - High Memory Usage (RSS)` | This alert fires when a Collector's memory usage (RSS) exceeds 2GB. This could be an early indicator of a memory leak or an under-provisioned host. | Count > 2000000000 | Count < = 2000000000 |
422-
| `OpenTelemetry Collector Insights - High Metadata Cardinality` | This alert fires when the batch processor is handling more than 1000 unique combinations of metadata. This is a known cause of performance degradation, high CPU, and high memory usage. | Count > 1000 | Count < = 1000 |
419+
| `OpenTelemetry Collector Insights - High Metadata Cardinality` | This alert fires when the batch processor is handling more than 1000 unique combinations of metadata. This is a known cause of performance degradation, high CPU, and high memory usage. | Count > 1000 | Count < = 1000 |

0 commit comments

Comments
 (0)