Merge branch 'main' into SUMO-254672-documentation

Author: sachin-sumologic

blog-service/2025-01-30-manage.md

@@ -0,0 +1,15 @@
+---
+title: Introducing Sumo Logic Organizations for Flex Customers (Manage)
+image: https://help.sumologic.com/img/sumo-square.png
+keywords:
+  - manage
+  - create-manage-orgs-flex
+  - flex-plan
+hide_table_of_contents: true    
+---
+
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+<a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a>
+
+We are excited to announce that we are now supporting Sumo Logic's Organizations ("Sumo Orgs") feature for Sumo Logic Flex customers. With this release, Flex customers can effectively group, provision, manage, and monitor the credit usage across multiple organizations, providing greater visibility and control over account structures. [Learn more](/docs/manage/manage-subscription/create-manage-orgs-flex).

docs/integrations/saas-cloud/cloudflare.md

@@ -56,9 +56,13 @@ This section shows you how to set up a Hosted Collector and specify a Sumo Logic
 
 To send Cloudflare logs to Sumo Logic directly, you can follow the steps outlined below, or follow the guide in the Cloudflare documentation ([Enable Logpush to Sumo Logic](https://developers.cloudflare.com/logs/get-started/enable-destinations/sumo-logic/)).
 
+:::info
+The Sumo Logic Cloudflare app works exclusively with **zone-scoped datasets**. For more information, refer to the [log fields](https://developers.cloudflare.com/logs/reference/log-fields/zone/) in the Cloudflare documentation.
+:::
+
 Cloudflare Logpush supports pushing logs directly to Sumo Logic via the Cloudflare dashboard or via API. Cloudflare can send logs to a Hosted Collector with HTTP Logs and Metrics as the source. Once you have set up a collector, you simply provide the HTTP Source Address (a unique URL) to which logs can be posted.
 
-Ensure Log Share permissions are enabled in Cloudflare before attempting to read or configure a Logpush job. For more information, refer to the [Roles](https://developers.cloudflare.com/fundamentals/account-and-billing/members/roles/#roles) section in  Cloudflare documentation.
+Ensure Log Share permissions are enabled in Cloudflare before attempting to read or configure a Logpush job. For more information, refer to the [Roles](https://developers.cloudflare.com/fundamentals/account-and-billing/members/roles/#roles) section in the Cloudflare documentation.
 
 ### Configure a Hosted Collector
 

docs/manage/manage-subscription/create-manage-orgs-flex.md

@@ -111,9 +111,8 @@ To change an org's credits allocation:
 
       **Example 2**: Suppose you need to increase credits for your child org. The image below shows that you have used 35 out of 31,026 credits allocated to your child org. To add more credits, select **Credits to be Added** and enter the additional credits required.<br/> <img src={useBaseUrl('img/manage/subscriptions/modify-allocation-recommendatio-example-2.png')} style={{border:'1px solid gray'}} alt="modify-allocation-recommendatio-example-2" width="450" />
 1. If you want to modify the baseline, click **View Baseline**. The credits calculator appears.
-      1. Click **Edit** and follow the steps in [Allocate Credits](#allocate-credits) to update the credits allocation.<br/> <img src={useBaseUrl('img/manage/subscriptions/baselines_2-flex.png')} style={{border:'1px solid gray'}} alt="edit-baseline" width="450" />
-      1. Depending on the new baseline values, the calculator now shows the recommended credit allocation, which provides a suggestion on how many credits you would need to add for the child org.
-      1. Once you set the baseline, you can view the recommended value in the **Credits to be Added** section.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-credits-to-add.png')} style={{border:'1px solid gray'}} alt="baseline-credits-to-add" width="450" />
+      1. Click **Edit** and follow the [step 4 in Allocate Credits](#allocate-credits) to update the credits allocation.<br/> <img src={useBaseUrl('img/manage/subscriptions/baselines_2-flex.png')} style={{border:'1px solid gray'}} alt="edit-baseline" width="450" />
+      1. Once you save the new baseline, you can view the recommended value in the **Credits to be Added/Reduced** section.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-credits-to-add.png')} style={{border:'1px solid gray'}} alt="baseline-credits-to-add" width="450" />
       1. (Optional) Click **View Details** to view the detailed breakdown of additional credits required value.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-view-details.png')} style={{border:'1px solid gray'}} alt="baseline-view-details" width="450" />
 1. Click **Save** once you finish editing the credit values.
 

docs/manage/manage-subscription/create-manage-orgs-service-providers.md

@@ -212,8 +212,7 @@ To change an org's credits allocation:
       **Example 2**: Consider you need to increase credits to your child org. The below image shows that you have used 35 credits out of 31026 credits allocated to your child org. Now, if you wish to increase the credits to your child org, select **Credits to be Added** and add the additional credits required.<br/> <img src={useBaseUrl('img/manage/subscriptions/modify-allocation-recommendatio-example-2.png')} style={{border:'1px solid gray'}} alt="modify-allocation-recommendatio-example-2" width="450" />
 1. If you want to modify the baseline, click **View Baseline**. The **Credits Calculator** appears.
       1. Click **Edit** and follow the steps in [Allocate Credits](#allocate-credits) to update the credits allocation.<br/> <img src={useBaseUrl('img/manage/subscriptions/edit-baseline.png')} style={{border:'1px solid gray'}} alt="edit-baseline" width="450" />
-      1. Depending on the new baseline values, the calculator now shows the recommended credit allocation, which provides a suggestion on how many credits you would need to add for the child org.<br/><img src={useBaseUrl('img/manage/subscriptions/edit-baseline-example.png')} style={{border:'1px solid gray'}} alt="edit-baseline" width="450" />
-      1. Once you set the baseline, you can view the recommended value in the **Credits to be Added** section.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-credits-to-add.png')} style={{border:'1px solid gray'}} alt="baseline-credits-to-add" width="450" />
+      1. Once you save the new baseline, you can view the recommended value in the **Credits to be Added/Reduced** section.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-credits-to-add.png')} style={{border:'1px solid gray'}} alt="baseline-credits-to-add" width="450" />
       1. (Optional) Click **View Details** to view the detailed breakdown of additional credits required value.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-view-details.png')} style={{border:'1px solid gray'}} alt="baseline-view-details" width="450" />
 1. Click **Save** once you finish editing the credit values.
 

docs/manage/manage-subscription/create-manage-orgs.md

@@ -175,8 +175,7 @@ To change an org's credits allocation:
       **Example 2**: Suppose you need to increase credits for your child org. The image below shows that you have used 35 out of 31,026 credits allocated to your child org. To add more credits, select **Credits to be Added** and enter the additional credits required.<br/> <img src={useBaseUrl('img/manage/subscriptions/modify-allocation-recommendatio-example-2.png')} style={{border:'1px solid gray'}} alt="modify-allocation-recommendatio-example-2" width="450" />
 1. If you want to modify the baseline, click **View Baseline**. The credits calculator appears.
       1. Click **Edit** and follow the steps in [Allocate Credits](#allocate-credits) to update the credits allocation.<br/> <img src={useBaseUrl('img/manage/subscriptions/edit-baseline.png')} style={{border:'1px solid gray'}} alt="edit-baseline" width="450" />
-      1. Based on the new baseline values, the calculator now shows the recommended credit allocation, suggesting how many credits you should add for the child org.<br/><img src={useBaseUrl('img/manage/subscriptions/edit-baseline-example.png')} style={{border:'1px solid gray'}} alt="edit-baseline" width="450" />
-      1. Once you set the baseline, you can view the recommended value in the **Credits to be Added** section.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-credits-to-add.png')} style={{border:'1px solid gray'}} alt="baseline-credits-to-add" width="450" />
+      1. Once you save the new baseline, you can view the recommended value in the **Credits to be Added/Reduced** section.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-credits-to-add.png')} style={{border:'1px solid gray'}} alt="baseline-credits-to-add" width="450" />
       1. (Optional) Click **View Details** to view the detailed breakdown of additional credits required value.<br/><img src={useBaseUrl('img/manage/subscriptions/baseline-view-details.png')} style={{border:'1px solid gray'}} alt="baseline-view-details" width="450" />
 1. Click **Save** once you finish editing the credit values.
 

docs/send-data/opentelemetry-collector/remote-management/index.md

@@ -44,4 +44,10 @@ In this section, we'll introduce the following concepts:
       <p>Discover how to apply processing rules for an OpenTelemetry agent using remote management source templates to enhance data handling.</p>
     </div>
   </div>
+    <div className="box smallbox card">
+    <div className="container">
+      <a href="/docs/send-data/opentelemetry-collector/remote-management/troubleshooting"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>Troubleshooting</h4></a>
+      <p>Find solutions to common issues with the OpenTelemetry collector remote management.</p>
+    </div>
+  </div>
 </div>

docs/send-data/opentelemetry-collector/remote-management/troubleshooting.md

@@ -0,0 +1,122 @@
+---
+id: troubleshooting
+title: Troubleshooting
+description: Learn about common troubleshooting scenarios of Sumo Logic OpenTelemetry collector remote management.
+---
+
+This document contains common troubleshooting scenarios about the Sumo Logic OpenTelemetry collector remote management.
+
+## Source template specific issues
+
+### Docker: Path permission denied
+
+#### Error message
+
+`
+Error: failed to setup configuration components: cannot start pipelines: permission denied while trying to connect to the Docker daemon socket at unix:///cav/run/docker.sock: Get "http://****>
+collector server run finished with error: failed to setup configuration components: cannot start pipelines: permission denied while trying to connect to the Docker daemon soc>
+`
+
+#### Solution
+
+1. Ensure that you have satisfied the [Docker source template pre-requisites](/docs/send-data/opentelemetry-collector/remote-management/source-templates/docker/#prerequisites).
+1. Restart the agent.
+
+### Windows: Failed to apply OpAMP agent remote config
+
+#### Error message
+
+`
+Failed to start service: invalid configuration: no receiver configuration specified in config
+`
+
+#### Solution
+
+1. Make sure that you have selected the **Event Channels/Scrappers** sub-options for the source template config.
+1. Delete the invalid configuration from machine path `/etc/otelcol-sumo/opamp.d` for Linux/Mac operating system or `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\opamp.d` for Windows operating system.
+1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from UI.
+1. Restart the agent.
+
+### Apache: Missing hostname / Invalid hostname
+
+#### Error message
+
+`
+Failed to apply OpAMP agent remote config   {"kind": "extension", "name": "opamp", "error": "cannot save the OpAMP effective config to /etc/otelcol-sumo/opamp.d: cannot validate config: receivers::apache/abcdf-***nha-aidn: missing hostname: 'localhost'"}
+`
+
+#### Solution
+
+1. Ensure that you have satisfied the [Apache source template pre-requisites](/docs/send-data/opentelemetry-collector/remote-management/source-templates/apache/#prerequisites).
+1. Delete the invalid configuration from machine path `/etc/otelcol-sumo/opamp.d` for Linux/Mac operating system or `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\opamp.d` for Windows operating system.
+1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from UI.
+1. Restart the agent.
+
+### Syslog: Failed to listen on interface
+
+#### Error message
+
+`
+Jan 17 11:34:14 ip-***-***-***-*** otelcol-sumo.sh[1234]: Error: failed to setup configuration components: cannot start pipelines: start stanza: failed to listen on interface: failed to configure tcp listener: listen tcp 0.0.0.0:***: bind: permission denied
+Jan 17 11:34:14 ip-***-***-***-*** otelcol-sumo.sh[1234]: 2025/01/17 11:34:14 collector server run finished with error: failed to setup configuration components: cannot start pipelines: start stanza: failed to listen on interface: failed to configure tcp listener: listen tcp 0.0.0.0:***: bind: permission denied
+`
+
+#### Solution
+
+1. Delete the invalid configuration from machine path `/etc/otelcol-sumo/opamp.d` for Linux/Mac operating system or `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\opamp.d` for Windows operating system.
+1. Update the invalid inputs (ensure that valid ports have the right permissions), delete invalid configuration source templates, or unlink the agent from UI.
+1. Restart the agent.
+
+## Agent disconnected from opamp server
+
+#### Error message
+
+`
+Agent Health Warning on UI : agent disconnected from opamp server. 
+`
+
+#### Solution
+
+Restart the agent.
+
+## Failed to apply OpAMP agent remote config
+
+#### Error messages
+
+Error message 1:
+
+`
+Failed to apply OpAMP agent remote config        {"kind": "extension", "name": "opamp", "error": "cannot save the OpAMP effective config to /etc/otelcol-sumo/opamp.d: cannot validate config: processors::filter/logs/abchdf-7946-4174-952f-bb52f016d2cd: unable to parse OTTL condition \"IsMatch(body, \\\"~!@#$%^&*()_+{}|:\\\\\\\"<>?/.,';\\\\\\\\][=-`\\\")\": couldn't create function: the pattern supplied to IsMatch is not a valid regexp pattern: error parsing regexp: missing closing ]: [=-""}
+`
+
+Error message 2:
+
+`
+collector server run finished with error: failed to setup configuration components: failed to build pipelines: failed to create "filelog/8ee0d9e8-92cf-46c8-97be-764c67e59a83" receiver for data type "logs": compile line end regex: error parsing regexp: unexpected
+`
+
+#### Solution
+
+1. Ensure the rules comply with [RE2 syntax](https://github.com/google/re2/wiki/Syntax). 
+1. Delete the invalid configuration from machine path `/etc/otelcol-sumo/opamp.d` for Linux/Mac operating system or `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\opamp.d` for Windows operating system.
+1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from UI. For example, replace the invalid regex with valid regex.
+
+## Agent crashes completely
+
+If there is a runtime error that leads the agent crash unexpectedly, follow the below steps to rectify the issue:
+
+1. Delete the invalid configuration from machine path `/etc/otelcol-sumo/opamp.d` for Linux/Mac operating system or `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\opamp.d` for Windows operating system.
+1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from UI.
+1. Restart the agent.
+
+## Agent stuck in the config processing loop
+
+If the agent repeatedly fails to process the effective configuration, it will be unable to perform any other operations, including sending heartbeat signals to the server. The server may interpret the absence of these heartbeats as an indication that the agent is offline, which can complicate recovery efforts. To resolve this issue, follow the below-mentioned steps:
+
+1. Delete the invalid configuration from machine path `/etc/otelcol-sumo/opamp.d` for Linux/Mac operating system or `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\opamp.d` for Windows operating system.
+1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from the user interface.
+1. Restart the agent.
+
+##  Agent sends failure response to the server
+
+If the agent attempts to apply the effective configuration but encounters errors, such as incompatible or invalid configuration parameters, it will send a failure response to the Opamp server to indicate the problem. This issue, however, disrupts data ingestion and leads to service interruptions. To resolve this, you can update the invalid inputs, delete any invalid configuration source templates, or unlink the agent from the UI.

sidebars.ts

@@ -257,6 +257,7 @@ module.exports = {
                     'send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules-windows',
                   ],
                 },
+                'send-data/opentelemetry-collector/remote-management/troubleshooting',
               ],
             },
             'send-data/opentelemetry-collector/auto-discovery',