Sumo Collection

The Sumo Collection app is a comprehensive tool that offers detailed insights into the health and status of Sumo Logic collectors and sources. It enables efficient management and monitoring by tracking key parameters such as collector types, versions, operational status, and source metrics through intuitive analytics and visualizations. By providing organizations with the data they need to make informed decisions and optimize their data management strategies, the app enhances operational efficiency and facilitates proactive issue identification within the Sumo Logic ecosystem.

With its comprehensive overview of collector and source activities, the app strengthens data collection infrastructure. Leveraging its analytics and visualization capabilities, organizations can make data-driven decisions, optimize performance, and ensure seamless data collection within the Sumo Logic environment.

info

This app includes built-in monitors. For details on creating custom monitors, refer to Create monitors for Sumo Collection app.

tip

For related info on collector health events, see this doc.

Log types

This app uses Sumo Logic’s Sumo Collection Source to collect the collectors and source logs from the Sumo Logic platform.

Sample log messages

Collector Log

{
    "id": 106288931,
    "name": "dc-windows-client2",
    "timeZone": "Etc/UTC",
    "fields": {},
    "links": [
        {
            "rel": "sources",
            "href": "/v1/collectors/106288231/sources"
        }
    ],
    "ephemeral": false,
    "targetCpu": -1,
    "sourceSyncMode": "UI",
    "installedCollectorSubtype": "Installed",
    "collectorType": "Installable",
    "collectorVersion": "19.376-1",
    "osVersion": "10.0",
    "osName": "Windows Server 2019",
    "osArch": "amd64",
    "lastSeenAlive": 1741775145414,
    "alive": false
}

Source Log

{
    "id": 116630551,
    "schemaRef": {
        "type": "Universal Connector"
    },
    "config": {
        "name": "YL UC continuation",
        "paginationContinuationTokenType": "body",
        "paginationContinuationTokenKey": "token",
        "responseLogsJsonPaths": [
            {
                "logTimestampFormat": "2025-03-12T15:55:35.405Z",
                "logsPath": "$.data[*]",
                "logTimestampPath": "$.modifiedAt"
            }
        ],
        "authBasicUsername": "NEWWWNAME",
        "requestEndpoint": "https://daorsXYCahaxe.xyz/api/v1/roles",
        "paginationContinuationTokenLocation": "headers",
        "paginationContinuationTokenJsonPath": "$.next",
        "clientRateLimitBurst": 1000,
        "authCategory": "Basic",
        "clientTimeoutRetries": 5,
        "parserPath": "",
        "requestBody": "",
        "requestMethod": "GET",
        "fields": {
            "_siemForward": false
        },
        "authBasicPassword": "********",
        "category": "yl/continuation",
        "clientRateLimitDuration": "1m",
        "pollingInterval": "1h",
        "requestParams": [
            {
                "paramName": "limit",
                "paramValue": "1"
            }
        ],
        "clientTimeoutDuration": "5m",
        "responseLogsType": "json",
        "paginationType": "ContinuationToken",
        "progressType": "none",
        "clientRateLimitReqs": 1000
    },
    "state": {
        "state": "Collecting"
    },
    "sourceType": "Universal",
    "alive": true
}

Sample queries

Total Sources

_sourceCategory="Labs/SumoCollection" sourceType
| json "id", "sourceType", "alive", "schemaRef.type", "state.state", "state.errorType", "state.errorInfo", "config.name", "state.errorCode", "config.fields._siemForward", "name", "category", "hostName", "automaticDateParsing", "multilineProcessingEnabled", "useAutolineMatching", "forceTimeZone", "encoding",  "fields._siemForward" as id, source_type, alive, c2c_source, state, error_type, error_info, name, error_code, siem_forward, source_name, category, host_name, automatic_date_parsing, multiline_processing_enabled, use_autoline_matching, force_time_zone, encoding, source_siem_forward nodrop

| where source_type matches "{{source_type}}"
| where if ("{{c2c_source}}" = "*", true, c2c_source matches "{{c2c_source}}")
| where if ("{{state}}" = "*", true, state matches "{{state}}")
| where if ("{{error_type}}" = "*", true, error_type matches "{{error_type}}")
| where if ("{{error_code}}" = "*", true, error_code matches "{{error_code}}")
| where alive matches "{{alive}}"

| count by id
| count

Collection configuration and app installation

Depending on the set up collection method, you can configure and install the app in three ways:

• Create a new collector and install the app. Create a new Sumo Logic Cloud-to-Cloud (C2C) source under a new Sumo Logic Collector and later install the app, or
• Use an existing collector and install the app. Create a new Sumo Logic Cloud-to-Cloud (C2C) source under an existing Sumo Logic Collector and later install the app, or
• Use existing source and install the app. Use your existing configured Sumo Logic Cloud-to-Cloud (C2C) source and install the app.

info

Use the Cloud-to-Cloud Integration for Sumo Collection to create the source and use the same source category while installing the app. By following these steps, you can ensure that your Sumo Collection app is properly integrated and configured to collect and analyze your Sumo Logic data.

Create a new collector and install the app

To set up collection and install the app, do the following:

note

Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, Manage Collectors capability depending upon the different content types part of the app.

1. Select App Catalog.
2. In the 🔎 Search Apps field, run a search for your desired app, then select it.
3. Click Install App.
   note

   Sometimes this button says Add Integration.

4. In the Set Up Collection section of your respective app, select Create a new Collector.
   1. Collector Name. Enter a Name to display for the Source in the Sumo Logic web application. The description is optional.
   2. Timezone. Set the default time zone when it is not extracted from the log timestamp. Time zone settings on Sources override a Collector time zone setting.
   3. (Optional) Metadata. Click the +Add Metadata link to add custom log Metadata Fields. Define the fields you want to associate, each metadata field needs a name (key) and value.
      • A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
      • An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
   4. Click Next.
5. Configure the source as specified in the Info box above, ensuring all required fields are included.
6. In the Configure section of your respective app, complete the following fields.
   1. Field Name. If you already have collectors and sources setup, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value .
7. Click Next. You will be redirected to the Preview & Done section.

Post-installation

Once your app is installed, it will appear in your Installed Apps folder, and dashboard panels will start to fill automatically.

Each panel slowly fills with data matching the time range query and received since the panel was created. Results will not immediately be available, but will update with full graphs and charts over time.

Use an existing collector and install the app

To setup source in the existing collector and install the app, do the following:

note

Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, Manage Collectors capability depending upon the different content types part of the app.

1. Select App Catalog.
2. In the 🔎 Search Apps field, run a search for your desired app, then select it.
3. Click Install App.
   note

   Sometimes this button says Add Integration.

4. In the Set Up Collection section of your respective app, select Use an existing Collector.
5. From the Select Collector dropdown, select the collector that you want to setup your source with and click Next.
6. Configure the source as specified in the Info box above, ensuring all required fields are included.
7. In the Configure section of your respective app, complete the following fields.
   1. Field Name. If you already have collectors and sources setup, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value .
8. Click Next. You will be redirected to the Preview & Done section.

Post-installation

Once your app is installed, it will appear in your Installed Apps folder, and dashboard panels will start to fill automatically.

Each panel slowly fills with data matching the time range query and received since the panel was created. Results will not immediately be available, but will update with full graphs and charts over time.

Use an existing source and install the app

To skip collection and only install the app, do the following:

note

Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, Manage Collectors capability depending upon the different content types part of the app.

1. Select App Catalog.
2. In the 🔎 Search Apps field, run a search for your desired app, then select it.
3. Click Install App.
   note

   Sometimes this button says Add Integration.

4. In the Set Up Collection section of your respective app, select Skip this step and use existing source and click Next.
5. In the Configure section of your respective app, complete the following fields.
   1. Field Name. If you already have collectors and sources setup, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value .
6. Click Next. You will be redirected to the Preview & Done section.

Post-installation

Once your app is installed, it will appear in your Installed Apps folder, and dashboard panels will start to fill automatically.

Each panel slowly fills with data matching the time range query and received since the panel was created. Results will not immediately be available, but will update with full graphs and charts over time.

Viewing the Sumo Collection dashboards​​

All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level.

• You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. Learn more.
• You can use template variables to drill down and examine the data on a granular level. For more information, see Filtering Dashboards with Template Variables.
• Most Next-Gen apps allow you to provide the scope at the installation time and are comprised of a key (_sourceCategory by default) and a default value for this key. Based on your input, the app dashboards will be parameterized with a dashboard variable, allowing you to change the dataset queried by all panels. This eliminates the need to create multiple copies of the same dashboard with different queries.

Collectors Overview

The Sumo Collection - Collectors Overview dashboard provides a comprehensive view of data collection processes within Sumo Logic. It offers insights into total collectors, their distribution by type and version, the operational status of installed and hosted collectors, and collector-source relationships. You can track collectors by time zone, operating system, and associated sources, streamlining management and monitoring. With detailed health and performance metrics, the dashboard enables you to optimize data collection, make informed decisions, and ensure smooth operations. By offering real-time visibility and trend analysis, it empowers you to improve data collection infrastructure and prioritize actions for better performance and reliability.

Sources Overview

The Sumo Collection - Sources Overview dashboard provides offers a detailed view of data sources within Sumo Logic, enabling effective monitoring and management of data ingestion. It displays metrics such as total sources, source categorization, distribution of Cloud-to-Cloud (C2C) sources, and the health status of C2C sources. You can analyze sources by error states, identify top C2C vendors, and track error counts to resolve issues quickly. The dashboard also highlights specific error types like THIRD-PARTY-CONFIG and THIRD-PARTY-GENERIC, providing insights to optimize data flow and improve data quality. With its analytics and visualizations, you can proactively manage data sources, make informed decisions, and ensure reliable data ingestion within the Sumo Logic ecosystem.

Sources Time Lag

The Sumo Collection - Sources Time Lag dashboard offers a comprehensive view of time delaysthat are affecting Cloud-to-Cloud (C2C) sources within the Sumo Logic platform. This dashboard is designed to help you to monitor data transmission efficiency by highlighting metrics such as average, maximum, and minimum time lags, while also identifying the top 10 sources with significant delays.

Create monitors for Sumo Collection app

From your App Catalog:

1. From the Sumo Logic navigation, select App Catalog.
2. In the Search Apps field, search for and then select your app.
3. Make sure the app is installed.
4. Navigate to What's Included tab and scroll down to the Monitors section.
5. Click Create next to the pre-configured monitors. In the create monitors window, adjust the trigger conditions and notifications settings based on your requirements.
6. Scroll down to Monitor Details.
7. Under Location click on New Folder.
   note

   By default, monitor will be saved in the root folder. So to make the maintenance easier, create a new folder in the location of your choice.

8. Enter Folder Name. Folder Description is optional.
   tip

   Using app version in the folder name will be helpful to determine the versioning for future updates.

9. Click Create. Once the folder is created, click on Save.

Sumo Collection monitors

Name	Description	Trigger Type (Critical / Warning / MissingData)	Alert Condition
C2C Sources with THIRD-PARTY-CONFIG Errors	This alert is triggered when Cloud-to-Cloud (C2C) sources encounter THIRD-PARTY-CONFIG errors, causing potential issues in the data ingestion process.	Critical	Count > 0

Upgrading the Sumo Collection app (Optional)

To update the app, do the following:

note

Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, Manage Collectors capability depending upon the different content types part of the app.

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
   Optionally, you can identify apps that can be upgraded in the Upgrade available section.
3. To upgrade the app, select Upgrade from the Manage dropdown.
   1. If the upgrade does not have any configuration or property changes, you will be redirected to the Preview & Done section.
   2. If the upgrade has any configuration or property changes, you will be redirected to Setup Data page.
      1. In the Configure section of your respective app, complete the following fields.
         1. Field Name. If you already have collectors and sources setup, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value .
      2. Click Next. You will be redirected to the Preview & Done section.

Post-update

Your upgraded app will be installed in the Installed Apps folder, and dashboard panels will start to fill automatically.

note

See our Release Notes changelog for new updates in the app.

To revert the app to a previous version, do the following:

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
3. To version down the app, select Revert to < previous version of your app > from the Manage dropdown.

Uninstalling the Sumo Collection app (Optional)

To uninstall the app, do the following:

1. Select App Catalog.
2. In the 🔎 Search Apps field, run a search for your desired app, then select it.
3. Click Uninstall.