Skip to content

SUMO-254673 non-FER apps #5231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Apr 8, 2025
Merged

SUMO-254673 non-FER apps #5231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6dfcf75
SUMO-251067 | Apoorv | Add. ActiveMQ docs updation
Apoorvkudesia-sumologic Jan 29, 2025
6b5cc5e
SUMO-251067 | Apoorv | Fix. PR comments
Apoorvkudesia-sumologic Jan 29, 2025
a76194c
SUMO-251067 | Apoorv | Add. Kafka docs updation
Apoorvkudesia-sumologic Jan 30, 2025
c46c29f
SUMO-251067 | Apoorv | Add. RabbitMQ docs updation
Apoorvkudesia-sumologic Jan 30, 2025
7041463
SUMO-251067 | Apoorv | Add. Github, Gitlab and Bitbucket docs updation
Apoorvkudesia-sumologic Jan 30, 2025
f18b069
Merge branch 'main' into SUMO-254673-doc-changes-for-v-1-to-v-2-migra…
jpipkin1 Jan 30, 2025
c646862
Updates from review
jpipkin1 Jan 31, 2025
65d5b38
SUMO-251067 | Apoorv | Add. PR review comments
Apoorvkudesia-sumologic Feb 3, 2025
c8a7798
SUMO-254673 | Apoorv | Revert changes for container apps
Apoorvkudesia-sumologic Apr 2, 2025
390a167
Changes for reusable section update and updating reference in all the…
sumoanema Apr 7, 2025
f5a1ff9
syntax fix for importing common reuse files
sumoanema Apr 7, 2025
ccb7e12
Merge branch 'main' into SUMO-254673-non-fer-apps
sumoanema Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 6 additions & 16 deletions docs/integrations/app-development/bitbucket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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**. <br/>[**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**‎.<br/><img src={useBaseUrl('img/integrations/app-development/BB_Collect_Log.png')} alt="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';

<AppInstall/>
<AppInstall2/>

## 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).
:::
<ViewDashboards/>

### Overview

Expand Down
17 changes: 8 additions & 9 deletions docs/integrations/app-development/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**. <br/>[**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**‎.<br/><img src={useBaseUrl('img/integrations/app-development/Field_x-github-event.png')} alt="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';

<AppInstall/>
<AppInstall2/>

#### Troubleshooting

Expand All @@ -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';

<ViewDashboards/>

### Overview

The **GitHub - Overview** dashboard provides an at-a-glance view of your GitHub issues, pull requests, and the commits over time.
Expand Down
18 changes: 8 additions & 10 deletions docs/integrations/app-development/gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**. <br/>[**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';

<AppInstall/>

<AppInstall2/>

### Troubleshooting

Expand All @@ -128,6 +122,10 @@ Do the following to resolve:

## Viewing GitLab Dashboards

import ViewDashboards from '../../reuse/apps/view-dashboards.md';

<ViewDashboards/>

### Overview

The **GitLab - Overview** dashboard provides users with a high-level view of events such as Issues, Merge Requests, Builds, Deployments, and pipelines.
Expand Down
11 changes: 4 additions & 7 deletions docs/integrations/app-development/jira-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

<AppInstall/>
<AppInstall2/>

## 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';

<ViewDashboards/>

### Issue Overview

Expand Down
12 changes: 5 additions & 7 deletions docs/integrations/saas-cloud/opsgenie.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

<AppInstall/>
<AppInstall2/>

## 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';

<ViewDashboards/>

### Overview

Expand Down
14 changes: 5 additions & 9 deletions docs/integrations/saas-cloud/pagerduty-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

<AppInstall/>
<AppInstall2/>

## 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';

<ViewDashboards/>

### Overview

Expand Down
14 changes: 5 additions & 9 deletions docs/integrations/saas-cloud/pagerduty-v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

<AppInstall/>
<AppInstall2/>

## 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';

<ViewDashboards/>

### Overview

Expand Down
8 changes: 4 additions & 4 deletions docs/reuse/apps/app-collection-option-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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**.
Expand All @@ -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**
Expand Down
8 changes: 4 additions & 4 deletions docs/reuse/apps/app-collection-option-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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**.
Expand All @@ -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**
Expand Down
8 changes: 4 additions & 4 deletions docs/reuse/apps/app-collection-option-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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**.
Expand All @@ -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**
Expand Down
8 changes: 4 additions & 4 deletions docs/reuse/apps/app-install-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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**.
Expand All @@ -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**
Expand Down
8 changes: 4 additions & 4 deletions docs/reuse/apps/app-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. <br/>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**
Expand Down