Skip to content

Commit bd75641

Browse files
sumoanemajpipkin1
andauthored
Docs for customYaml Source template - beta release (#5926)
* Docs for customYaml Source template - beta release * note added for supported otel collector version * Added beta article tagging * Adding base url to correct the failing build in PR * Updates from review --------- Co-authored-by: John Pipkin <[email protected]>
1 parent 9c3d44b commit bd75641

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed

cid-redirects.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1848,6 +1848,7 @@
18481848
"/cid/10341": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/postgresql",
18491849
"/cid/10342": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/mysql",
18501850
"/cid/10343": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/elasticsearch",
1851+
"/cid/10348": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/customyaml",
18511852
"/cid/10325": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/apache/changelog",
18521853
"/cid/10326": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/linux/changelog",
18531854
"/cid/10327": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/localfile/changelog",
@@ -1864,6 +1865,7 @@
18641865
"/cid/10345": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/mysql/changelog",
18651866
"/cid/10346": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/elasticsearch/changelog",
18661867
"/cid/10347": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/st-with-secrets",
1868+
"/cid/10349": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/customyaml/changelog",
18671869
"/cid/10817": "/docs/integrations/sumo-apps/cse",
18681870
"/cid/10818": "/docs/integrations/sumo-apps/cse",
18691871
"/cid/1082": "/docs/metrics/introduction/get-started-metrics",
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
id: changelog
3+
title: Changelog
4+
sidebar_label: Changelog
5+
description: Changelog for Custom Yaml source template for OpenTelemetry.
6+
---
7+
8+
<head>
9+
<meta name="robots" content="noindex" />
10+
</head>
11+
12+
<p><a href={useBaseUrl('docs/beta')}><span className="beta">Beta</span></a></p>
13+
14+
import useBaseUrl from '@docusaurus/useBaseUrl';
15+
16+
## [1.0.0] - 2025-10-24
17+
18+
### Added
19+
- Initial version of Custom Yaml source template.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
slug: /send-data/opentelemetry-collector/remote-management/source-templates/customyaml
3+
title: Custom YAML Source Template
4+
sidebar_label: Custom YAML
5+
description: Learn about the Sumo Logic Custom YAML source template for OpenTelemetry.
6+
---
7+
8+
<head>
9+
<meta name="robots" content="noindex" />
10+
</head>
11+
12+
<p><a href={useBaseUrl('docs/beta')}><span className="beta">Beta</span></a></p>
13+
14+
import useBaseUrl from '@docusaurus/useBaseUrl';
15+
import Tabs from '@theme/Tabs';
16+
import TabItem from '@theme/TabItem';
17+
18+
19+
The Custom YAML source template creates an OpenTelemetry configuration based on a provided OpenTelemetry config YAML, that can be pushed to a remotely managed OpenTelemetry collector (abbreviated as otelcol). It lets you directly define and manage collector configurations in YAML format for more flexibility. By creating this source template and pushing the config to the appropriate OpenTelemetry agent, you can collect telemetry data to send to Sumo Logic.
20+
21+
:::note
22+
This source template works with sumo remotely managed OpenTelemetry collector version >= 0.136.0
23+
:::
24+
25+
## Configuring the source template
26+
27+
Follow these steps to set up and deploy the source template to a remotely managed OpenTelemetry collector.
28+
29+
### Step 1: Set up remotely managed OpenTelemetry collector
30+
31+
import CollectorInstallation from '../../../../../reuse/apps/opentelemetry/collector-installation.md';
32+
33+
<CollectorInstallation/>
34+
35+
### Step 2: Configure the source template
36+
37+
In this step, you will configure the YAML required for Apache Collection. Below are the inputs required for configuration:
38+
39+
- **Name**. Name of the source template.
40+
- **Description**. Description for the source template.
41+
- **YAML Configuration**. You can directly provide your OpenTelemetry configurations in YAML format.
42+
43+
### Step 3: Push the source template to the desired remotely managed collectors
44+
45+
import DataConfiguration from '../../../../../reuse/apps/opentelemetry/data-configuration.md';
46+
47+
<DataConfiguration/>
48+
49+
:::info
50+
Refer to the [changelog](changelog.md) for information on periodic updates to this source template.
51+
:::

0 commit comments

Comments
 (0)