diff --git a/docs/integrations/app-development/bitbucket.md b/docs/integrations/app-development/bitbucket.md index 277a64aefd..4e38d6e943 100644 --- a/docs/integrations/app-development/bitbucket.md +++ b/docs/integrations/app-development/bitbucket.md @@ -125,7 +125,6 @@ In this step, you configure a Hosted Collector to receive Webhook Events from Bi 8. **Triggers** - Click on Choose from a full list of triggers, and choose all triggers under Repository, Issue and Pull Request. 9. Click **Save** - ### Step 3: Configure the Bitbucket CI/CD Pipeline to Collect Deploy Events A Bitbucket pipe needs to be configured to send code deploy status to Sumo Logic. Add the following pipe code to the step section of your deployment part of the `bitbucket-pipelines.yml` file. Replace `SUMOLOGIC_HTTP_URL` with HTTP Source URL configured in Step 1. @@ -141,30 +140,21 @@ If you want to deployment events to multiple Sumo Logic orgs, include a `-pipe` For reference: This is how the [bitbucket-pipelines.yml](https://bitbucket.org/app-dev-sumo/backendservice/src/master/bitbucket-pipelines.yml) looks after adding deploy pipe code to our sample Bitbucket CI/CD pipeline. +### Step 4: Bitbucket Event-Key tagging at Sumo Logic -### Step 4: Enable Bitbucket Event-Key tagging at Sumo Logic - -Sumo Logic needs to understand the event type for incoming events (for example, repo:push events). To enable this, the [X-Event-Key](https://confluence.atlassian.com/bitbucket/event-payloads-740262817.html#EventPayloads-HTTPheaders) event type needs to be enabled. To enable this, perform the following steps in the Sumo Logic console: - -1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**. -2. Add Field ‎**X-Event-Key**‎.
Bitbucket - +To properly identify the event type for incoming events (for example, repo:push events), Sumo Logic automatically adds the [X-Event-Key](https://confluence.atlassian.com/bitbucket/event-payloads-740262817.html#EventPayloads-HTTPheaders) event type to the [Fields](/docs/manage/fields) during app installation. ## Installing the Bitbucket App -This section provides instructions for installing the Bitbucket app. - -import AppInstall from '../../reuse/apps/app-install.md'; +import AppInstall2 from '../../reuse/apps/app-install-v2.md'; - + ## Viewing Bitbucket Dashboards -This section provides descriptions and examples for each of the pre-configured app dashboards. +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; -:::tip Filter with template variables -Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables.md). -::: + ### Overview diff --git a/docs/integrations/app-development/github.md b/docs/integrations/app-development/github.md index 3b6ce86e1c..2e6a8dc3a7 100644 --- a/docs/integrations/app-development/github.md +++ b/docs/integrations/app-development/github.md @@ -156,21 +156,16 @@ To configure a GitHub Webhook: 6. Click **Add Webhook**. -### Enable GitHub Event tagging at Sumo Logic - -Sumo Logic needs to understand the event type for incoming events. To enable this, the [x-github-event](https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads) event type needs to be enabled. To enable this, perform the following steps in the Sumo Logic console: - -1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**. -2. Add Field ‎**x-github-event**‎.
Field_GitHub +### GitHub Event tagging at Sumo Logic +To properly identify the event type for incoming events (for example, repo:push events), Sumo Logic automatically adds the [x-github-event](https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads) event type to the [Fields](/docs/manage/fields) during app installation. ## Installing the GitHub App -Now that you have set up collector GitHub, install the Sumo Logic App for GitHub to use the preconfigured searches and dashboards to analyze your data. -import AppInstall from '../../reuse/apps/app-install.md'; +import AppInstall2 from '../../reuse/apps/app-install-v2.md'; - + #### Troubleshooting @@ -182,6 +177,10 @@ If you are getting the following error after installing the app - `Field x-githu ## Viewing ​GitHub Dashboards +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + + ### Overview The **GitHub - Overview** dashboard provides an at-a-glance view of your GitHub issues, pull requests, and the commits over time. diff --git a/docs/integrations/app-development/gitlab.md b/docs/integrations/app-development/gitlab.md index 95ed6bbaa6..b0f5ae6fe8 100644 --- a/docs/integrations/app-development/gitlab.md +++ b/docs/integrations/app-development/gitlab.md @@ -91,21 +91,15 @@ You can register webhooks for a [Group](https://docs.gitlab.com/ee/user/project/ Refer to the [GitLab Webhooks documentation](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#configure-a-webhook) to understand more. -### Step 3: Enable GitLab Event tagging at Sumo Logic - -Sumo Logic needs to understand the event type for incoming events. To enable this, the [x-gitlab-event](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html#push-events) event type needs to be enabled. To enable this, perform the following steps in the Sumo Logic console: - -1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**. -2. Add Field ‎**x-GitLab-event**‎. +### Step 3: GitLab Event tagging at Sumo Logic +To properly identify the event type for incoming events, Sumo Logic automatically adds the [x-gitlab-event](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html#push-events) event type to the [Fields](/docs/manage/fields) during app installation. ## Installing the GitLab App +import AppInstall2 from '../../reuse/apps/app-install-v2.md'; -import AppInstall from '../../reuse/apps/app-install.md'; - - - + ### Troubleshooting @@ -128,6 +122,10 @@ Do the following to resolve: ## Viewing GitLab Dashboards +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + + ### Overview The **GitLab - Overview** dashboard provides users with a high-level view of events such as Issues, Merge Requests, Builds, Deployments, and pipelines. diff --git a/docs/integrations/app-development/jira-cloud.md b/docs/integrations/app-development/jira-cloud.md index 765d7d5ae8..986ad6eb0b 100644 --- a/docs/integrations/app-development/jira-cloud.md +++ b/docs/integrations/app-development/jira-cloud.md @@ -169,18 +169,15 @@ When you configure the Webhook, enter the URL for the HTTP source you created in ## Installing the Jira Cloud App -This section demonstrates how to install the Jira Cloud App. +import AppInstall2 from '../../reuse/apps/app-install-v2.md'; -import AppInstall from '../../reuse/apps/app-install.md'; - - + ## Viewing Jira Cloud Dashboards -:::tip Filter with template variables -Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables.md). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + ### Issue Overview diff --git a/docs/integrations/saas-cloud/opsgenie.md b/docs/integrations/saas-cloud/opsgenie.md index 8f948f516c..1d39282e69 100644 --- a/docs/integrations/saas-cloud/opsgenie.md +++ b/docs/integrations/saas-cloud/opsgenie.md @@ -86,17 +86,15 @@ To configure log collection for the Opsgenie App, do the following: ## Installing the Opsgenie App -This section provides instructions for installing the Opsgenie App, as well as examples of each of the app dashboards. +import AppInstall2 from '../../reuse/apps/app-install-v2.md'; -import AppInstall from '../../reuse/apps/app-install.md'; - - + ## Viewing OpsGenie Dashboards -:::tip Filter with template variables -Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables.md). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview diff --git a/docs/integrations/saas-cloud/pagerduty-v2.md b/docs/integrations/saas-cloud/pagerduty-v2.md index 4d9ebdf38b..e1ee60ca58 100644 --- a/docs/integrations/saas-cloud/pagerduty-v2.md +++ b/docs/integrations/saas-cloud/pagerduty-v2.md @@ -70,19 +70,15 @@ To create a PagerDuty V2 Webhook, do the following: ## Installing the PagerDuty V2 App -This section provides instructions for installing the Sumo App for PagerDuty V2. +import AppInstall2 from '../../reuse/apps/app-install-v2.md'; -Now that you have set up a log and metric collection, you can install the Sumo Logic App for PagerDuty V2, and use its pre-configured searches and dashboards. - -import AppInstall from '../../reuse/apps/app-install.md'; - - + ## Viewing PagerDuty v2 Dashboards -:::tip Filter with template variables -Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables.md). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview diff --git a/docs/integrations/saas-cloud/pagerduty-v3.md b/docs/integrations/saas-cloud/pagerduty-v3.md index 24aaea2641..2492d34215 100644 --- a/docs/integrations/saas-cloud/pagerduty-v3.md +++ b/docs/integrations/saas-cloud/pagerduty-v3.md @@ -93,19 +93,15 @@ In the next section, install the Sumo Logic App for PagerDuty V3. ## Installing the PagerDuty V3 App -This section provides instructions for installing the Sumo App for PagerDuty V3. +import AppInstall2 from '../../reuse/apps/app-install-v2.md'; -Now that you have set up a log and metric collection, you can install the Sumo Logic App for PagerDuty V3, and use its pre-configured searches and dashboards. - -import AppInstall from '../../reuse/apps/app-install.md'; - - + ## Viewing PagerDuty V3 Dashboards -:::tip Filter with template variables -Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables.md). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview diff --git a/docs/reuse/apps/app-collection-option-1.md b/docs/reuse/apps/app-collection-option-1.md index f33d68e93a..14b1654ca6 100644 --- a/docs/reuse/apps/app-collection-option-1.md +++ b/docs/reuse/apps/app-collection-option-1.md @@ -1,5 +1,7 @@ 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**. 1. In the 🔎 **Search Apps** field, run a search for your desired app, then select it. 1. Click **Install App**. @@ -15,9 +17,7 @@ To set up collection and install the app, do the following: 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. - 1. **Key**. Select either of these options for the data source. - * Choose **Source Category** and select a source category from the list for **Default Value**. - * Choose **Custom**, and enter a custom metadata field. Insert its value in **Default Value**. + 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** . 1. Click **Next**. You will be redirected to the **Preview & Done** section. **Post-installation** diff --git a/docs/reuse/apps/app-collection-option-2.md b/docs/reuse/apps/app-collection-option-2.md index 2044e5b564..d7d2ef413e 100644 --- a/docs/reuse/apps/app-collection-option-2.md +++ b/docs/reuse/apps/app-collection-option-2.md @@ -1,5 +1,7 @@ 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**. 1. In the 🔎 **Search Apps** field, run a search for your desired app, then select it. 1. Click **Install App**. @@ -10,9 +12,7 @@ To setup source in the existing collector and install the app, do the following: 1. From the **Select Collector** dropdown, select the collector that you want to setup your source with and 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. - 1. **Key**. Select either of these options for the data source. - * Choose **Source Category** and select a source category from the list for **Default Value**. - * Choose **Custom**, and enter a custom metadata field. Insert its value in **Default Value**. + 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** . 1. Click **Next**. You will be redirected to the **Preview & Done** section. **Post-installation** diff --git a/docs/reuse/apps/app-collection-option-3.md b/docs/reuse/apps/app-collection-option-3.md index 72bcf58413..fcc615d915 100644 --- a/docs/reuse/apps/app-collection-option-3.md +++ b/docs/reuse/apps/app-collection-option-3.md @@ -1,5 +1,7 @@ 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**. 1. In the 🔎 **Search Apps** field, run a search for your desired app, then select it. 1. Click **Install App**. @@ -8,9 +10,7 @@ To skip collection and only install the app, do the following: ::: 1. In the **Set Up Collection** section of your respective app, select **Skip this step and use existing source** and click **Next**. 1. In the **Configure** section of your respective app, complete the following fields. - 1. **Key**. Select either of these options for the data source. - * Choose **Source Category** and select a source category from the list for **Default Value**. - * Choose **Custom**, and enter a custom metadata field. Insert its value in **Default Value**. + 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** . 1. Click **Next**. You will be redirected to the **Preview & Done** section. **Post-installation** diff --git a/docs/reuse/apps/app-install-v2.md b/docs/reuse/apps/app-install-v2.md index 01aa4c7c20..1221a0f471 100644 --- a/docs/reuse/apps/app-install-v2.md +++ b/docs/reuse/apps/app-install-v2.md @@ -1,5 +1,7 @@ To 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**. 1. In the 🔎 **Search Apps** field, run a search for your desired app, then select it. 1. Click **Install App**. @@ -8,9 +10,7 @@ To install the app, do the following: ::: 1. Click **Next** in the **Setup Data** section. 1. In the **Configure** section of your respective app, complete the following fields. - 1. **Key**. Select either of these options for the data source. - * Choose **Source Category** and select a source category from the list for **Default Value**. - * Choose **Custom**, and enter a custom metadata field. Insert its value in **Default Value**. + 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** . 1. Click **Next**. You will be redirected to the **Preview & Done** section. **Post-installation** diff --git a/docs/reuse/apps/app-update.md b/docs/reuse/apps/app-update.md index b3add69683..90eeedf29b 100644 --- a/docs/reuse/apps/app-update.md +++ b/docs/reuse/apps/app-update.md @@ -1,14 +1,14 @@ 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**. 1. 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. 1. 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. 1. 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. - - **Key**. Select either of these options for the data source. - * Choose **Source Category** and select a source category from the list for **Default Value**. - * Choose **Custom** and enter a custom metadata field. Insert its value in **Default Value**. + 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** . 1. Click **Next**. You will be redirected to the **Preview & Done** section. **Post-update**