diff --git a/docs/reuse/apps/app-collection-option-1.md b/docs/reuse/apps/app-collection-option-1.md index 141e836f5a..2234f40466 100644 --- a/docs/reuse/apps/app-collection-option-1.md +++ b/docs/reuse/apps/app-collection-option-1.md @@ -1,3 +1,5 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + 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, and Manage Collectors capabilities depending upon the different content types part of the app. @@ -12,8 +14,8 @@ To set up collection and install the app, do the following: 1. **Collector Name**. Enter a Name to display the Source in the Sumo Logic web application. The description is optional. 1. **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. 1. (Optional) **Metadata**. Click the **+Add Metadata** link to add a custom log [Metadata Fields](/docs/manage/fields). Define the fields you want to associate, each metadata field needs a name (key) and value. - * green check circle.png A green circle with a checkmark is shown when the field exists and is enabled in the Fields table schema. - * orange exclamation point.png 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, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**. + * green check circle.png A green circle with a checkmark is shown when the field exists and is enabled in the Fields table schema. + * orange exclamation point.png 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, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**. 1. Click **Next**. 1. Configure the source as specified in the `Info` box above, ensuring all required fields are included. 1. In the **Configure** section of your respective app, complete the following fields. diff --git a/docs/reuse/apps/app-install-index-apps-v2.md b/docs/reuse/apps/app-install-index-apps-v2.md index a5c5e6a7de..6accd2f483 100644 --- a/docs/reuse/apps/app-install-index-apps-v2.md +++ b/docs/reuse/apps/app-install-index-apps-v2.md @@ -1,9 +1,11 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + To install the app: 1. Select **App Catalog**. 1. In the **Search Apps** field, search for and then select your app. 1. Optionally, you can scroll down to preview the dashboards included with the app. Then, click **Install App** (sometimes this button says **Add Integration**). 1. Click **Next**. -1. Look for the dialog confirming that your app was installed successfully.
app-success-sumo-apps.png +1. Look for the dialog confirming that your app was installed successfully.
app-success-sumo-apps.png Once an app is installed, it will appear in your **Personal** folder or the folder that you specified. From here, you can share it with other users in your organization. Dashboard panels will automatically start to fill with data matching the time range query received since you created the panel. Results won't be available immediately, but within about 20 minutes, you'll see completed graphs and maps. diff --git a/docs/reuse/apps/app-install-sumo-apps.md b/docs/reuse/apps/app-install-sumo-apps.md index 820a0ac91e..1d4830cd1c 100644 --- a/docs/reuse/apps/app-install-sumo-apps.md +++ b/docs/reuse/apps/app-install-sumo-apps.md @@ -1,3 +1,5 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + To install the app: 1. Select **App Catalog**. @@ -7,6 +9,6 @@ To install the app: * **Folder Name**. You can retain the existing name or enter a custom name of your choice for the app. * **All Folders** (optional). Default location is the **Personal** folder in your **Library**. If desired, you can choose a different location and/or click **New Folder** to add it to a new folder. 1. Click **Next**. -1. Look for the dialog confirming that your app was installed successfully.
app-success-sumo-apps.png +1. Look for the dialog confirming that your app was installed successfully.
app-success-sumo-apps.png Once an app is installed, it will appear in your **Personal** folder or the folder that you specified. From here, you can share it with other users in your organization. Dashboard panels will automatically start to fill with data matching the time range query received since you created the panel. Results won't be available immediately, but within about 20 minutes, you'll see completed graphs and maps. diff --git a/docs/reuse/apps/app-install.md b/docs/reuse/apps/app-install.md index cbfbacc8d3..820c0c857a 100644 --- a/docs/reuse/apps/app-install.md +++ b/docs/reuse/apps/app-install.md @@ -1,3 +1,5 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + To install the app: 1. Select **App Catalog**. @@ -13,7 +15,7 @@ To install the app: * **Folder Name**. You can retain the existing name or enter a custom name of your choice for the app. * **All Folders** (optional). The default location is the **Personal** folder in your **Library**. If desired, you can choose a different location and/or click **New Folder** to add it to a new folder. 1. Click **Next**. -1. Look for the dialog confirming that your app was installed successfully.
app-success.png +1. Look for the dialog confirming that your app was installed successfully.
app-success.png **Post-installation** diff --git a/docs/reuse/apps/create-aws-s3-source.md b/docs/reuse/apps/create-aws-s3-source.md index 4ad569d7b2..b3244b421d 100644 --- a/docs/reuse/apps/create-aws-s3-source.md +++ b/docs/reuse/apps/create-aws-s3-source.md @@ -1,3 +1,5 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + When you create an AWS Source, you'll need to identify the Hosted Collector you want to use or create a new Hosted Collector. Once you create an AWS Source, associate it with a Hosted Collector. For instructions, see [Configure a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector). #### Rules @@ -46,8 +48,8 @@ These configuration instructions apply to log collection from all AWS Source typ * Add an **account** field and assign it a value which is a friendly name / alias to your AWS account from which you are collecting logs. Logs can be queried via the “account field”. * Add a **region** field and assign it the value of respective AWS region where the Load Balancer exists. * Add an **accountId** field and assign it the value of the respective AWS account id which is being used. - * green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema. - * orange exclamation point.png 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, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**. + * green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema. + * orange exclamation point.png 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, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**. 11. For **AWS Access**, choose between the two **Access Method** options below, based on the AWS authentication you are providing. * For **Role-based access**, enter the Role ARN that was provided by AWS after creating the role. Role-based access is recommended (this was completed in the prerequisite step [Grant Sumo Logic access to an AWS Product](/docs/send-data/hosted-collectors/amazon-aws/grant-access-aws-product)). * For **Key access**, enter the **Access Key ID** and **Secret Access Key**. See [AWS Access Key ID](http://docs.aws.amazon.com/STS/latest/UsingSTS/UsingTokens.html#RequestWithSTS) and [AWS Secret Access Key](https://aws.amazon.com/iam/) for details. diff --git a/docs/reuse/apps/opentelemetry/collector-installation.md b/docs/reuse/apps/opentelemetry/collector-installation.md index d90d6faa7e..d3d2d2facd 100644 --- a/docs/reuse/apps/opentelemetry/collector-installation.md +++ b/docs/reuse/apps/opentelemetry/collector-installation.md @@ -1,3 +1,5 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + In this step, we'll install the collector and add a uniquely identifiable tag to these collectors. 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic main menu select **Data Management**, and then under **Data Collection** select **OpenTelemetry Collection**. You can also click the **Go To...** menu at the top of the screen and select **OpenTelemetry Collection**. @@ -9,6 +11,6 @@ In this step, we'll install the collector and add a uniquely identifiable tag to 1. Leave the **Collector Settings** at their default values to configure collectors as remotely managed. 1. Under **Generate and run the command to install the collector**, copy and run the installation command in your system terminal where the collector needs to be installed. 1. After installation is complete, click **Next** to proceed. -1. Select a source template (for example, Apache source template) to start collecting logs from all linked collectors, then proceed with the data configuration.
source template page +1. Select a source template (for example, Apache source template) to start collecting logs from all linked collectors, then proceed with the data configuration.
source template page To revisit this screen later: From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic), select **Manage Data > Collection > Source Template**. From the [**New UI**](/docs/get-started/sumo-logic-ui), select **Data Management** and under **Data Collection** select **Source Template**. diff --git a/docs/reuse/apps/opentelemetry/data-configuration.md b/docs/reuse/apps/opentelemetry/data-configuration.md index c6223807bd..be74e15206 100644 --- a/docs/reuse/apps/opentelemetry/data-configuration.md +++ b/docs/reuse/apps/opentelemetry/data-configuration.md @@ -1,3 +1,5 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + :::info A new source template will always be created with the latest version of the source template. ::: @@ -5,8 +7,8 @@ A new source template will always be created with the latest version of the sour Follow the below steps to create a data collection configuration to gather the required logs and link them to all the collectors with the help of collector tags. 1. Complete the source template form with the name and file path for your logs (for example, error logs or access logs), then click **Next**. -1. Under **Link Collectors**, you will have the option to link the collectors using the collector name or by adding tags to find the group of collectors (for example, `application = Apache`).
Screenshot of the file path configuration for Apache logs -1. Preview and confirm the collectors that will be linked (fetched automatically) to the newly created source template.
Screenshot showing the linked collectors preview
Screenshot showing the linked collectors preview +1. Under **Link Collectors**, you will have the option to link the collectors using the collector name or by adding tags to find the group of collectors (for example, `application = Apache`).
Screenshot of the file path configuration for Apache logs +1. Preview and confirm the collectors that will be linked (fetched automatically) to the newly created source template.
Screenshot showing the linked collectors preview
Screenshot showing the linked collectors preview 1. Click **Next** to complete the source template creation. In the background, the system will apply the configuration to all the linked collectors and will start collecting the respective telemetry data from the remote host (in the example, it would start collecting Apache error logs). 1. Click the **Log Search** or **Metrics Search** icons to search for and analyze your data collected for this source template. diff --git a/docs/reuse/apps/opentelemetry/process-metric-collection.md b/docs/reuse/apps/opentelemetry/process-metric-collection.md index c7e4edec8b..7727772270 100644 --- a/docs/reuse/apps/opentelemetry/process-metric-collection.md +++ b/docs/reuse/apps/opentelemetry/process-metric-collection.md @@ -1,9 +1,11 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + By default, the collector will not send process metrics to Sumo Logic. This is because the number of processes running on a host can be very large, which would result in a significant increase in Data Points per Minute (DPM). Click the **Enable process metric collection** checkbox to collect [process-level metrics](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md). - **Name of process**. Add the list of process names. - **Include/Exclude the above pattern**. Signifies if you want to exclude or include the metrics for the processes listed previously. -- **Match type for process name**. Select if the process name given should be considered for a strict match with the host machine processes or if it should be considered as regex when matching.
process-metric-collection +- **Match type for process name**. Select if the process name given should be considered for a strict match with the host machine processes or if it should be considered as regex when matching.
process-metric-collection :::note diff --git a/docs/reuse/aws-cost-explorer.md b/docs/reuse/aws-cost-explorer.md index 4c47233166..ca230212e5 100644 --- a/docs/reuse/aws-cost-explorer.md +++ b/docs/reuse/aws-cost-explorer.md @@ -1,13 +1,15 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + To configure an AWS Cost Explorer Source: 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic main menu select **Data Management**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. 1. On the Collection page, click **Add Source** next to a Hosted Collector. -1. Search for and select **AWS Cost Explorer**.
aws-cost-explorer-icon -1. Enter a **Name** for the Source in the Sumo Logic console. The **Description** is optional.
cost-explorer-v2-1-1.png +1. Search for and select **AWS Cost Explorer**.
aws-cost-explorer-icon +1. Enter a **Name** for the Source in the Sumo Logic console. The **Description** is optional.
cost-explorer-v2-1-1.png 1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) is stored in a searchable field called `_sourceCategory`. 1. For [Fields](/docs/manage/fields), click the **+Add** link to add custom log metadata. Define the fields you want to associate. Each field needs a name (key) and value. - * green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema. - * orange exclamation point.png 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, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**.

It is preferable to add an **account** field (for the dashboards) and assign it a friendly name to identify the corresponding AWS account.
![accountField.png](/img/send-data/accountField.png) + * green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema. + * orange exclamation point.png 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, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**.

It is preferable to add an **account** field (for the dashboards) and assign it a friendly name to identify the corresponding AWS account.
![accountField.png](/img/send-data/accountField.png) 1. For the **AWS Access Key** and **AWS Secret Key**, provide the IAM User access key and secret key you want to use to authenticate collection requests. Make sure your IAM user has the following IAM policy attached with it. ```json { diff --git a/docs/reuse/filter-dashboards.md b/docs/reuse/filter-dashboards.md index b21269b555..3b2914a57c 100644 --- a/docs/reuse/filter-dashboards.md +++ b/docs/reuse/filter-dashboards.md @@ -1,5 +1,7 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + 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](/docs/dashboards/set-custom-time-ranges/). - If required, [configure](/docs/dashboards/about/#auto-refresh) the refresh interval rate for a dashboard or panel by clicking the drop-down arrow next to the refresh icon. -- Click the funnel icon in the dashboard top menu bar to [filter dashboard with Template Variables](/docs/dashboards/filter-template-variables/).
filter-dashboards +- Click the funnel icon in the dashboard top menu bar to [filter dashboard with Template Variables](/docs/dashboards/filter-template-variables/).
filter-dashboards diff --git a/docs/reuse/restart-c2c-source.md b/docs/reuse/restart-c2c-source.md index 65120c7914..675940f72e 100644 --- a/docs/reuse/restart-c2c-source.md +++ b/docs/reuse/restart-c2c-source.md @@ -1,3 +1,5 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; + If your Source encounters VendorConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API. #### UI @@ -5,9 +7,9 @@ If your Source encounters VendorConfig errors, you can restart it from either th To restart your source in the Sumo Logic platform, follow the steps below: 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic main menu select **Data Management**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. 2. Select the source and click the **information** icon on the right side of the row. -3. The API usage information popup is displayed. Click the **Restart Source** button on the bottom left.
restart-source-button -4. Click **Confirm** to send the restart request.
restart-source-confirm -5. The bottom left of the platform will provide a notification informing you the request was successful.
restart-source-initiated +3. The API usage information popup is displayed. Click the **Restart Source** button on the bottom left.
restart-source-button +4. Click **Confirm** to send the restart request.
restart-source-confirm +5. The bottom left of the platform will provide a notification informing you the request was successful.
restart-source-initiated #### API diff --git a/docs/reuse/ui-elements.md b/docs/reuse/ui-elements.md index e47bb6f3bf..090e041697 100644 --- a/docs/reuse/ui-elements.md +++ b/docs/reuse/ui-elements.md @@ -1,21 +1,22 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; [**New UI**](/docs/get-started/sumo-logic-ui) | Icon | Tab Name | Definition | | :-- | :-- | :-- | -| Recent icon | Recent | Access content you’ve recently accessed and recently shared with you. | -| Favorites icon | Favorites | Content you’ve marked as favorite. | -| Library icon | Library | List of all accessible content, including your creations and the content shared with you. | -| more-actions-kebab | More Actions / Three-Dot Kebab | Click to reveal a menu with additional options. | -| Sumo Logic left nav menu | Left Nav | Access all Sumo Logic features, such as Log Search, Metrics, Infrastructure Monitoring, Application Monitoring, and Cloud SIEM, as well as your dashboards library. | +| Recent icon | Recent | Access content you’ve recently accessed and recently shared with you. | +| Favorites icon | Favorites | Content you’ve marked as favorite. | +| Library icon | Library | List of all accessible content, including your creations and the content shared with you. | +| more-actions-kebab | More Actions / Three-Dot Kebab | Click to reveal a menu with additional options. | +| Sumo Logic left nav menu | Left Nav | Access all Sumo Logic features, such as Log Search, Metrics, Infrastructure Monitoring, Application Monitoring, and Cloud SIEM, as well as your dashboards library. | [**Classic UI (Legacy)**](/docs/get-started/sumo-logic-ui-classic) | Icon | Tab Name | Definition | | :-- | :-- | :-- | -| classic-icon-recents | Recents | Access content you’ve recently accessed and recently shared with you. | -| classic-icon-recents | Favorites | Content you’ve marked as favorite. | -| classic-icon-recents | Personal | Content you manage. | -| classic-icon-library.png | Library | List of all accessible content, including your creations and the content shared with you. | -| classic-icon-more-actions-kebab-three-dot.png | More Actions / Three-Dot Kebab | Click to reveal a menu with additional options. | -| nav-menu.png | Navigation Menu | Main Sumo Logic menu containing your collectors, sources, library, help, and more. | +| classic-icon-recents | Recents | Access content you’ve recently accessed and recently shared with you. | +| classic-icon-recents | Favorites | Content you’ve marked as favorite. | +| classic-icon-recents | Personal | Content you manage. | +| classic-icon-library.png | Library | List of all accessible content, including your creations and the content shared with you. | +| classic-icon-more-actions-kebab-three-dot | More Actions / Three-Dot Kebab | Click to reveal a menu with additional options. | +| nav-menu.png | Navigation Menu | Main Sumo Logic menu containing your collectors, sources, library, help, and more. |