Skip to content

Commit 5d524c6

Browse files
JV0812jpipkin1kimsauce
authored
Enable/Disable a source template (#5144)
* Enable/Disable a source template * Updates from review * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md Co-authored-by: Kim (Sumo Logic) <[email protected]> --------- Co-authored-by: John Pipkin <[email protected]> Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent a063428 commit 5d524c6

File tree

4 files changed

+21
-3
lines changed

4 files changed

+21
-3
lines changed

docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ For more details on source templates, see [Installed Collector Sources](/docs/se
6969

7070
To edit a source template:
7171

72-
1. In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**.
72+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**.<br/>[**New UI**](/docs/get-started/sumo-logic-ui). Go to the Sumo Logic top menu and select **Configuration > Collection > Source Template**.
7373
1. Select the source template that you need to edit, and click **Edit**. Or, click the kebab menu against the selected source template and click **Edit** from the dropdown.
7474
1. Change the required configuration in the source template configuration page, and click **Next**.
7575
1. If required, update the collectors on the **Link Collectors** page.
@@ -95,6 +95,23 @@ You cannot upgrade a source template if there are any incompatible collector ver
9595
1. Click the **Delete** button (or use the kebab menu against the selected source template, click **Delete** from the dropdown).
9696
1. Confirm the deletion. The source template will be removed from the **Source Template** page and unlinked from all collectors.
9797

98+
## Enable/disable a source template
99+
100+
You can enable or disable a source template to optimize your data flow management. Below are some of the key benefits of enabling or disabling the source template:
101+
102+
- **Cost efficiency.** Proactively manage and reduce costs associated with excessive or unnecessary data ingestion.
103+
- **Compliance protection.** Safeguard your organization from compliance violations by preventing potential exposure of sensitive information in logs.
104+
- **Agility in response.** Quickly address misconfigurations or anomalies in your data sources without disrupting other crucial workflows.
105+
106+
Follow the below steps to enable or disable a source template:
107+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**.<br/>[**New UI**](/docs/get-started/sumo-logic-ui). Go to the Sumo Logic top menu and select **Configuration > Collection > Source Template**.<br/><img src={useBaseUrl('img/send-data/st-landing-page.png')} alt="source-template-landing-page" style={{border:'1px solid gray'}} width="800"/>
108+
1. Select the source template that you need to enable or disable. Click **More Actions** > **Enable** or **Disable** the source template. Or, click the kebab menu against the selected source template and click **Enable** or **Disable** from the dropdown.<br/><img src={useBaseUrl('img/send-data/enable-st.png')} alt="enable-source-template" style={{border:'1px solid gray'}} width="800"/>
109+
1. Enter **CONFIRM** and click the **Confirm** button to complete the action.<br/><img src={useBaseUrl('img/send-data/enable-confirm-st.png')} alt="confirm-enable-source-template" style={{border:'1px solid gray'}} width="600"/>
110+
111+
When you re-enable a disabled source template, the collection can either start from the very beginning of the file or from the moment when you re-enabled the source template. Collection starting from the beginning could lead to duplicate data while collecting data from the re-enabled moment can lead to data loss for the duration the source template was inactive.
112+
113+
In the disabled state, only minor and patch versions will be auto-upgraded and you will be blocked from upgrading the source template with any major pending Source Schema version. It is recommended that you first enable the source template before manually upgrading it.
114+
98115
## Collector tags
99116

100117
With remote management, you can tag your [OpenTelemetry Collectors](/docs/send-data/opentelemetry-collector) to categorize and group them. These tags are also enriched in your data, enabling you to use them in your dashboards and searches.
@@ -107,9 +124,9 @@ With remote management, you can tag your [OpenTelemetry Collectors](/docs/send-d
107124

108125
You can add collector tags during OTEL collector setup as described in the previous section. Follow the below steps to add, update, or delete the collector tags after creation:
109126

110-
1. Navigate to the **OpenTelemetry Collection** page.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collection.png')} alt="opentelemetry-collection" style={{border:'1px solid gray'}} width="700"/>
127+
1. Navigate to the **OpenTelemetry Collection** page.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collection.png')} alt="opentelemetry-collection" style={{border:'1px solid gray'}} width="800"/>
111128
1. Click on the desired collector where you need to add collector tags.
112-
1. In the right pane, scroll to the **Collector Tags** section and click **Edit**.<br/><img src={useBaseUrl('img/send-data/collector-tags-edit.png')} alt="collector-tags-edit" style={{border:'1px solid gray'}} width="500"/>
129+
1. In the right pane, scroll to the **Collector Tags** section and click **Edit**.<br/><img src={useBaseUrl('img/send-data/collector-tags-edit.png')} alt="collector-tags-edit" style={{border:'1px solid gray'}} width="800"/>
113130
1. In the edit window, click **+ Add tags** to add a new tag. You can also update or delete the required tags. Then click **Proceed**.<br/><img src={useBaseUrl('img/send-data/add-delete-update-tags.png')} alt="add-delete-update-tags" style={{border:'1px solid gray'}} width="500"/>
114131
1. A new **Update Collector Tag(s)** window appears. Click the **click here** link to understand the impact of this update.<br/><img src={useBaseUrl('img/send-data/update-tags-click-here.png')} alt="update-tags-click-here" style={{border:'1px solid gray'}} width="500"/>
115132
1. You will be redirected to the **Mapped Source Template** section, which displays the mapped source templates for the collector tags added. This window also displays the **Compatible** and **Incompatible Version** details for the mapped source template for the collector.<br/><img src={useBaseUrl('img/send-data/mapped-source-templates.png')} alt="mapped-source-templates" style={{border:'1px solid gray'}} width="500"/>
@@ -124,3 +141,4 @@ If you try to add or update any collector tags using the API, the following vali
124141
1. Validates if the disco tags are added, updated, or deleted.
125142
1. Validates if the default tags are added or deleted.
126143
:::
144+
76 KB
Loading

static/img/send-data/enable-st.png

522 KB
Loading
419 KB
Loading

0 commit comments

Comments
 (0)