Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Create monitoring dashboards in Sysdig Monitor
title: Create monitoring dashboards in Sysdig

slug: sysdig-monitor-create-monitoring-dashboards

description: Describes how to monitoring dashboards for a team scoped applications in Sysdig Monitor.
description: Describes how to monitor dashboards for team-scoped applications with Sysdig.

keywords: sysdig, monitoring, openshift monitoring, developer guide, team guide, team, configure, monitoring dashboards, dashboard templates
keywords: sysdig, monitoring, openshift monitoring, developer guide, team guide, team, configure, monitoring dashboards, dashboard templates, Sysdig Monitor, Sysdig Secure, monitor, secure

page_purpose: Details the steps for creating monitoring dashboards in Sysdig Monitor.
page_purpose: Details the steps for creating monitoring dashboards in Sysdig.

audience: developer, technical lead

Expand All @@ -18,15 +18,14 @@ content_owner: Shelly Han
sort_order: 3
---

# Create monitoring dashboards in Sysdig Monitor

Last updated: **January 2, 2024**
# Create monitoring dashboards in Sysdig
Last updated: **October 16, 2026**

After you [create a sysdig-team](../app-monitoring/sysdig-monitor-setup-team.md) and set up a dedicated space in Sysdig to monitor applications in your OpenShift Project Set, follow the steps in this guide to learn more about monitoring.

## On this page

- [Create monitoring dashboards in Sysdig Monitor](#create-monitoring-dashboards-in-sysdig-monitor)
- [Create monitoring dashboards in Sysdig](#create-monitoring-dashboards-in-sysdig)
- [On this page](#on-this-page)
- [Sysdig built-in monitoring dashboard templates](#sysdig-built-in-monitoring-dashboard-templates)
- [Create custom dashboard from templates](#create-custom-dashboard-from-templates)
Expand Down Expand Up @@ -91,8 +90,8 @@ Once a dashboard is deleted, you can not get it back. That's why it's highly rec

## Related pages

- [Set up a team in Sysdig Monitor](../app-monitoring/sysdig-monitor-setup-team.md)
- [Set up advanced functions in Sysdig Monitor](../app-monitoring/sysdig-monitor-set-up-advanced-functions.md)
- [Sysdig Monitor](https://docs.sysdig.com/en/sysdig-monitor.html)
- [Set up a team in Sysdig](../app-monitoring/sysdig-monitor-setup-team.md)
- [Set up advanced functions in Sysdig](../app-monitoring/sysdig-monitor-set-up-advanced-functions.md)
- [Sysdig Monitor Docs](https://docs.sysdig.com/en/sysdig-monitor.html)
- [Sysdig Monitor Dashboards](https://docs.sysdig.com/en/dashboards.html)
- [The four Golden Signals of Monitoring](https://sysdig.com/blog/golden-signals-kubernetes)
19 changes: 11 additions & 8 deletions src/docs/app-monitoring/sysdig-monitor-onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ sort_order: 1
---

# Onboarding to application monitoring with Sysdig
Last updated: **January 9, 2024**
Last updated: **October 16, 2026**

Monitor your Kubernetes hosts with [Sysdig Monitor](https://sysdig.com/products/monitor/). Create custom dashboards, alerts, and operational-level captures to diagnose issues at the application or platform level. This guide will walk you through using Sysdig Monitor for your new or existing applications.
Monitor your Kubernetes hosts in Sysdig using [Sysdig Monitor](https://sysdig.com/products/monitor/). Create custom dashboards, alerts, and operational-level captures to diagnose issues at the application or platform level. This guide will walk you through using Sysdig Monitor for your new or existing applications.

## Follow this onboarding guide

1. [Set up a team in Sysdig Monitor](../app-monitoring/sysdig-monitor-setup-team.md)
2. [Create monitoring dashboards in Sysdig Monitor](../app-monitoring/sysdig-monitor-create-monitoring-dashboards.md)
3. [Create alerts and notifications in Sysdig Monitor](../app-monitoring/sysdig-monitor-create-alert-channels.md)
4. [Set up advanced metrics in Sysdig Monitor](../app-monitoring/sysdig-monitor-set-up-advanced-functions.md)
1. [Set up a team in Sysdig](../app-monitoring/sysdig-monitor-setup-team.md)
2. [Create monitoring dashboards in Sysdig](../app-monitoring/sysdig-monitor-create-monitoring-dashboards.md)
3. [Create Sysdig alerts and notifications in MS Teams](https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/webhooks/msteams-webhooks/) <!-- TODO: replace with new Teams alert channel doc -->
4. [Set up advanced metrics in Sysdig](../app-monitoring/sysdig-monitor-set-up-advanced-functions.md)
5. [Resource monitoring dashboards](../app-monitoring/resource-monitoring-dashboards.md)

If you have any questions about Sysdig or application monitoring, please contact the Platform Services team in the [OpenShift-howto-sysdig](https://teams.microsoft.com/l/channel/19%3A93dff023d40c4440b26cf9c0b236a93f%40thread.tacv2/OpenShift-howto-sysdig?groupId=a80418da-c27b-406e-89ab-7695b61924d8&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) channel in MS Teams.
Expand All @@ -37,15 +37,18 @@ If you have any questions about Sysdig or application monitoring, please contact


## Related pages
- [BCDevOps Sysdig Monitor Service](https://app.sysdigcloud.com/api/oauth/openid/bcdevops)

- [BCDevOps Sysdig Service](https://app.sysdigcloud.com/api/oauth/openid/bcdevops)
- [Sysdig Monitor](https://sysdig.com/products/monitor/)
- [Sysdig Secure](https://sysdig.com/platform/secure)
- [OpenShift project resource quotas](../automation-and-resiliency/openshift-project-resource-quotas.md)
- [Sysdig API](https://docs.sysdig.com/en/docs/developer-tools/sysdig-rest-api-conventions/)
- [Monitoring with Sysdig](https://digital.gov.bc.ca/technology/cloud/private/products-tools/sysdig/)
- [Sydig User Profile](https://app.sysdigcloud.com/#/settings/user)
- [MS Teams OpenShift-howto-sysdig channel](https://teams.microsoft.com/l/channel/19%3A93dff023d40c4440b26cf9c0b236a93f%40thread.tacv2/OpenShift-howto-sysdig?groupId=a80418da-c27b-406e-89ab-7695b61924d8&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc)
- [Sysdig Monitor](https://docs.sysdig.com/en/sysdig-monitor.html)
- [Sysdig Monitor Docs](https://docs.sysdig.com/en/sysdig-monitor.html)
- [Sysdig Monitor Dashboards](https://docs.sysdig.com/en/dashboards.html)
- [Sysdig Secure Docs](https://docs.sysdig.com/en/docs/sysdig-secure)
- [Sysdig Alerts](https://docs.sysdig.com/en/alerts.html)
- [Sysdig Alerts with Kubernetes and PromQL](https://sysdig.com/blog/alerting-kubernetes/)
- [Sysdig Teams Blog](https://sysdig.com/blog/introducing-sysdig-teams/)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Set up advanced metrics in Sysdig Monitor
title: Set up advanced metrics in Sysdig

slug: sysdig-monitor-set-up-advanced-functions

description: Describes how to set up and configure advanced functions for a team in Sysdig Monitor.
description: Describes how to set up and configure advanced functions for a team in Sysdig using Sysdig Monitor.

keywords: sysdig, monitoring, openshift monitoring, developer guide, team guide, team, configure, advanced functions, custom monitoring, PromQL, Service Discovery

Expand All @@ -18,13 +18,13 @@ content_owner: Shelly Han
sort_order: 5
---

# Set up advanced metrics in Sysdig Monitor
Last updated: **April 17, 2024**
# Set up advanced metrics in Sysdig
Last updated: **October 16, 2026**

This page is a comprehensive guide to setting up advanced metrics in Sysdig Monitor. It covers the creation of PromQL metrics, using PromQL in alerts, and employing Service Discovery to import application metrics endpoints into Sysdig. The guide includes practical examples and step-by-step instructions, serving as a valuable resource for users looking to enhance their monitoring capabilities with Sysdig.
This page is a comprehensive guide to setting up advanced metrics in Sysdig using [Sysdig Monitor](https://sysdig.com/products/monitor/). It covers the creation of PromQL metrics, using PromQL in alerts, and employing Service Discovery to import application metrics endpoints into Sysdig. The guide includes practical examples and step-by-step instructions, serving as a valuable resource for users looking to enhance their monitoring capabilities with Sysdig.

## On this page
- [Set up advanced metrics in Sysdig Monitor](#set-up-advanced-metrics-in-sysdig-monitor)
- [Set up advanced metrics in Sysdig](#set-up-advanced-metrics-in-sysdig)
- [Creating PromQL metrics](#creating-promql-metrics)
- [Create a PromQL based alert](#create-a-promql-based-alert)
- [Use Service Discovery to import application metrics endpoints](#use-service-discovery-to-import-application-metrics-endpoints)
Expand Down Expand Up @@ -78,11 +78,12 @@ To enable Promscrape to find your application metrics, do the following:

## Related pages

- [Set up a team in Sysdig Monitor](../app-monitoring/sysdig-monitor-setup-team.md)
- [Create alert channels in Sysdig Monitor](../app-monitoring/sysdig-monitor-create-alert-channels.md)
- [BCDevOps Sysdig Service](https://app.sysdigcloud.com/api/oauth/openid/bcdevops)
- [Set up a team in Sysdig](../app-monitoring/sysdig-monitor-setup-team.md)
- [Create Sysdig alerts in MS Teams](https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/webhooks/msteams-webhooks/)
- [MS Teams OpenShift-howto-sysdig channel](https://teams.microsoft.com/l/channel/19%3A93dff023d40c4440b26cf9c0b236a93f%40thread.tacv2/OpenShift-howto-sysdig?groupId=a80418da-c27b-406e-89ab-7695b61924d8&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc)
- [Migrate Using Default Configuration](https://docs.sysdig.com/en/docs/sysdig-monitor/integrations/working-with-integrations/custom-integrations/collect-prometheus-metrics/migrating-from-promscrape-v1-to-v2/#migrate-using-default-configuration)
- [Sysdig Monitor](https://docs.sysdig.com/en/sysdig-monitor.html)
- [Sysdig Monitor Docs](https://docs.sysdig.com/en/sysdig-monitor.html)
- [Sysdig Monitor Dashboards](https://docs.sysdig.com/en/dashboards.html)
- [Sysdig Alerts](https://docs.sysdig.com/en/alerts.html)
- [Sysdig Alerts with Kubernetes and PromQL](https://sysdig.com/blog/alerting-kubernetes/)
Expand Down
33 changes: 18 additions & 15 deletions src/docs/app-monitoring/sysdig-monitor-setup-team.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Set up a team in Sysdig Monitor
title: Set up a team in Sysdig

slug: sysdig-monitor-setup-team

description: Describes how to set up and configure a team in Sysdig Monitor.
description: Describes how to set up and configure a team in Sysdig.

keywords: sysdig, sysdig monitor, sysdig team, monitoring, openshift monitoring, developer guide, team guide, team, configure
keywords: sysdig, sysdig monitor, sysdig, sysdig secure, sysdig team, monitoring, openshift monitoring, developer guide, team guide, team, configure

page_purpose: Details the steps for setting up a team and reviewing the capabilities of Sysdig Monitor.
page_purpose: Details the steps for setting up a team and reviewing the capabilities of Sysdig.

audience: developer, technical lead

Expand All @@ -18,16 +18,16 @@ content_owner: Shelly Han
sort_order: 2
---

# Set up a team in Sysdig Monitor
Last updated: **January 2, 2024**
# Set up a team in Sysdig
Last updated: **October 16, 2026**

[Sysdig Monitor](https://sysdig.com/products/monitor/) provides system-level monitoring of Kubernetes hosts and the ability to create custom dashboards, alerts, and operational-level captures to diagnose application or platform-level issues.
[BCDevOps Sysdig Service](https://app.sysdigcloud.com/api/oauth/openid/bcdevops) grants combined product access to Sysdig Monitor and Sysdig Secure. [Sysdig Monitor](https://sysdig.com/products/monitor/) provides system-level monitoring of Kubernetes hosts and the ability to create custom dashboards, alerts, and operational-level captures to diagnose application or platform-level issues. [Sysdig Secure](https://sysdig.com/platform/secure) delivers threat detection, vulnerability management, posture management, and identity & entitlement management.

Effective monitoring and alerting are crucial components of maintaining a robust and reliable system. Monitoring allows your team to proactively identify potential issues before they impact your application, enabling timely responses and minimizing downtime. The platform services team strongly recommends that all teams implement the dashboards presented here as a minimum standard for ensuring the health and performance of their applications.

The Sysdig Teams Operator runs in the cluster and enables a team to create and manage access to a dedicated Sysdig Team account for BC Gov Private Cloud PaaS users. The team is scoped to the OpenShift namespaces that belong to the team. Sysdig also provides a default dashboard to identify system [resources, limits, and actual usage](../automation-and-resiliency/openshift-project-resource-quotas.md).

For more information on Sysdig Monitor, see [Monitoring with Sysdig](https://digital.gov.bc.ca/technology/cloud/private/products-tools/sysdig/)
For more information on Sysdig, see [Monitoring with Sysdig](https://digital.gov.bc.ca/technology/cloud/private/products-tools/sysdig/)

## On this page
- [Sign in to Sysdig](#sign-in-to-sysdig)
Expand All @@ -41,9 +41,9 @@ For more information on Sysdig Monitor, see [Monitoring with Sysdig](https://dig
## Sign in to Sysdig
You and your team must sign in to Sysdig to create the user account. The B.C. government Sysdig uses OpenID Connect and requires either an IDIR account or a GitHub account.

- Go to the [BCDevOps Sysdig Monitor](https://app.sysdigcloud.com/api/oauth/openid/bcdevops).
- Go to the [BCDevOps Sysdig Acess](https://app.sysdigcloud.com/api/oauth/openid/bcdevops).

- Alternatively, you can also sign in on [the Sysdig site](https://app.sysdigcloud.com). Select OpenID and type `BCDevOps` as the company.
- Alternatively, you can also sign in on [the Sysdig site](https://app.sysdigcloud.com). Select OpenID and type `BCDevOps` as the company. You must select the 'US East' region with this login method.

- Upon login, you will be presented with a default page. You may be directed to the **Catchall Team** which has access to no resources at the moment (the team resources and access will be created in later steps).

Expand Down Expand Up @@ -103,7 +103,7 @@ A list of users to be added to this team.

**Note:**

- Only apply role updates to the custom resource from `tools` namespace. Do not use the Sysdig Monitor UI to modify team access, because the operator reconciliation will overwrite any UI changes to team roles and settings.
- Only apply role updates to the custom resource from `tools` namespace. Do not use the Sysdig UI to modify team access, because the operator reconciliation will overwrite any UI changes to team roles and settings.
- If your project set is on Gold and GoldDR clusters, only create the `sysdig-team` custom resource in the Gold cluster. The Sysdig operator can create the dashboards for your applications across both clusters.
- It's important to keep a single and unique `sysdig-team` custom resource per project set because you don't want to have duplicated teams on Sysdig. Please make sure to remove `sysdig-team` custom resource from dev, test and prod namespaces if they are created accidentally.

Expand Down Expand Up @@ -192,16 +192,19 @@ To access them:

## Related pages

- [BCDevOps Sysdig Monitor Service](https://app.sysdigcloud.com/api/oauth/openid/bcdevops)
- [Set up advanced functions in Sysdig Monitor](../app-monitoring/sysdig-monitor-set-up-advanced-functions.md)
- [Create alert channels in Sysdig Monitor](../app-monitoring/sysdig-monitor-create-alert-channels.md)
- [BCDevOps Sysdig Service](https://app.sysdigcloud.com/api/oauth/openid/bcdevops)
- [Set up advanced functions in Sysdig](../app-monitoring/sysdig-monitor-set-up-advanced-functions.md)
- [Create Sysdig alerts in MS Teams](https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/webhooks/msteams-webhooks/)
- [Sysdig Monitor](https://sysdig.com/products/monitor/)
- [Sysdig Secure](https://sysdig.com/platform/secure)
- [OpenShift project resource quotas](../automation-and-resiliency/openshift-project-resource-quotas.md)
- [Sysdig API](https://docs.sysdig.com/en/docs/developer-tools/sysdig-rest-api-conventions/)
- [Monitoring with Sysdig](https://cloud.gov.bc.ca/private-cloud/our-products-in-the-private-cloud-paas/monitoring-with-sysdig/)
- [Sydig User Profile](https://app.sysdigcloud.com/#/settings/user)
- [Sysdig User Profile](https://app.sysdigcloud.com/#/settings/user)
- [MS Teams OpenShift-howto-sysdig channel](https://teams.microsoft.com/l/channel/19%3A93dff023d40c4440b26cf9c0b236a93f%40thread.tacv2/OpenShift-howto-sysdig?groupId=a80418da-c27b-406e-89ab-7695b61924d8&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc)
- [Sysdig Monitor Docs](https://docs.sysdig.com/en/sysdig-monitor.html)
- [Sysdig Monitor Dashboards](https://docs.sysdig.com/en/dashboards.html)
- [Sysdig Secure Docs](https://docs.sysdig.com/en/docs/sysdig-secure)
- [Sysdig Alerts](https://docs.sysdig.com/en/alerts.html)
- [Sysdig Alerts with Kubernetes and PromQL](https://sysdig.com/blog/alerting-kubernetes/)
- [Sysdig Teams Blog](https://sysdig.com/blog/introducing-sysdig-teams/)
Expand Down
19 changes: 10 additions & 9 deletions src/docs/app-monitoring/user-defined-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sort_order: 8
---
<!-- omit in toc -->
# Set up a User Defined Monitoring in OpenShift
Last updated: **Oct 29, 2024**
Last updated: **October 16, 2026**

Use Prometheus client libraries to push your app's metrics to Prometheus.

Expand All @@ -37,7 +37,7 @@ Use Prometheus client libraries to push your app's metrics to Prometheus.
- [Create custom alert rules](#create-custom-alert-rules)
- [Control alert receivers](#control-alert-receivers)
- [Sysdig Monitor](#sysdig-monitor)
- [Sysdig Monitor Alert](#sysdig-monitor-alert)
- [Sysdig Monitor Alerts](#sysdig-monitor-alerts)
- [Related pages](#related-pages)

## Instrument your application with custom metrics
Expand Down Expand Up @@ -299,13 +299,13 @@ response_count_total{code="200",url="http://nginx-openshift-bcgov-nagios.apps.kl
<...>
```

And same metrics can be seen in the Sysdig monitor web-console.
And same metrics can be seen in the Sysdig Monitor web-console.

![user defined monitoring2](../../images/user-defined-monitoring2.png)

## Sysdig Monitor Alert
## Sysdig Monitor Alerts

To set up Sysdig alert using your custom metrics, you'll need to create a dashboard with the metrics, and then you can setup an alert like below;
To set up Sysdig alerts using your custom metrics, you'll need to configure a dashboard with the metrics, and then you can create an alert like below;

![user defined monitoring3](../../images/user-defined-monitoring3.png)

Expand All @@ -315,8 +315,8 @@ Sysdig alert example;

For detail steps, please read the documents below:

- [Checking sysdig teams and dashboards](../app-monitoring/sysdig-monitor-setup-team.md#verify-sysdig-team-creation)
- [Creating sysdig alert](../app-monitoring/sysdig-monitor-create-alert-channels.md#creating-an-alert)
- [Checking Sysdig teams and dashboards](../app-monitoring/sysdig-monitor-setup-team.md#verify-sysdig-team-creation)
- [Create Sysdig alerts in MS Teams](https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/webhooks/msteams-webhooks/)

---

Expand All @@ -328,5 +328,6 @@ For detail steps, please read the documents below:
- [OCP - Creating alert routing](https://docs.openshift.com/container-platform/4.14/observability/monitoring/managing-alerts.html#creating-alert-routing-for-user-defined-projects_managing-alerts)
- [Sysdig - Automatically scraping any Kubernetes pods](https://docs.sysdig.com/en/docs/sysdig-monitor/integrations/working-with-integrations/custom-integrations/collect-prometheus-metrics/#agent-compatibility)
- [Sysdig - Use Service Discovery to import application metrics endpoints](../app-monitoring/sysdig-monitor-set-up-advanced-functions.md#use-service-discovery-to-import-application-metrics-endpoints)
- [Sysdig - Checking sysdig teams and dashboards](../app-monitoring/sysdig-monitor-setup-team.md#verify-sysdig-team-creation)
- [Sysdig - Creating sysdig alert](../app-monitoring/sysdig-monitor-create-alert-channels.md#creating-an-alert)
- [Sysdig - Checking Sysdig teams and dashboards](../app-monitoring/sysdig-monitor-setup-team.md#verify-sysdig-team-creation)
- [Sysdig Alerts](https://docs.sysdig.com/en/alerts.html)
- [Sysdig Alerts with Kubernetes and PromQL](https://sysdig.com/blog/alerting-kubernetes/)
Loading
Loading