Skip to content

Docs for customYaml Source template - beta release #5926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 24, 2025
+72 −0
Merged

Docs for customYaml Source template - beta release #5926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3673b29
Docs for customYaml Source template - beta release
sumoanema Oct 16, 2025
37f96ff
note added for supported otel collector version
sumoanema Oct 16, 2025
6f0f8a1
Added beta article tagging
sumoanema Oct 23, 2025
077094e
Adding base url to correct the failing build in PR
sumoanema Oct 23, 2025
bc70905
Updates from review
jpipkin1 Oct 23, 2025
26ae239
Merge branch 'main' into customeryamldoc
sumoanema Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions cid-redirects.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1848,6 +1848,7 @@
"/cid/10341": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/postgresql",
"/cid/10342": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/mysql",
"/cid/10343": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/elasticsearch",
"/cid/10348": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/customyaml",
"/cid/10325": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/apache/changelog",
"/cid/10326": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/linux/changelog",
"/cid/10327": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/localfile/changelog",
Expand All @@ -1864,6 +1865,7 @@
"/cid/10345": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/mysql/changelog",
"/cid/10346": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/elasticsearch/changelog",
"/cid/10347": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/st-with-secrets",
"/cid/10349": "/docs/send-data/opentelemetry-collector/remote-management/source-templates/customyaml/changelog",
"/cid/10817": "/docs/integrations/sumo-apps/cse",
"/cid/10818": "/docs/integrations/sumo-apps/cse",
"/cid/1082": "/docs/metrics/introduction/get-started-metrics",
Expand Down
19 changes: 19 additions & 0 deletions ...ntelemetry-collector/remote-management/source-templates/customyaml/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: changelog
title: Changelog
sidebar_label: Changelog
description: Changelog for Custom Yaml source template for OpenTelemetry.
---

<head>
<meta name="robots" content="noindex" />
</head>

<p><a href={useBaseUrl('docs/beta')}><span className="beta">Beta</span></a></p>

import useBaseUrl from '@docusaurus/useBaseUrl';

## [1.0.0] - 2025-10-24

### Added
- Initial version of Custom Yaml source template.
51 changes: 51 additions & 0 deletions .../opentelemetry-collector/remote-management/source-templates/customyaml/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
slug: /send-data/opentelemetry-collector/remote-management/source-templates/customyaml
title: Custom YAML Source Template
sidebar_label: Custom YAML
description: Learn about the Sumo Logic Custom YAML source template for OpenTelemetry.
---

<head>
<meta name="robots" content="noindex" />
</head>

<p><a href={useBaseUrl('docs/beta')}><span className="beta">Beta</span></a></p>

import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


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.

:::note
This source template works with sumo remotely managed OpenTelemetry collector version >= 0.136.0
:::

## Configuring the source template

Follow these steps to set up and deploy the source template to a remotely managed OpenTelemetry collector.

### Step 1: Set up remotely managed OpenTelemetry collector

import CollectorInstallation from '../../../../../reuse/apps/opentelemetry/collector-installation.md';

<CollectorInstallation/>

### Step 2: Configure the source template

In this step, you will configure the YAML required for Apache Collection. Below are the inputs required for configuration:

- **Name**. Name of the source template.
- **Description**. Description for the source template.
- **YAML Configuration**. You can directly provide your OpenTelemetry configurations in YAML format.

### Step 3: Push the source template to the desired remotely managed collectors

import DataConfiguration from '../../../../../reuse/apps/opentelemetry/data-configuration.md';

<DataConfiguration/>

:::info
Refer to the [changelog](changelog.md) for information on periodic updates to this source template.
:::