toc.yaml

toc:
  properties:
    subcollection: monitoring
    service-name: sysdig-monitor
    version: 2
    category: logging_monitoring
    audience: service
    href: /docs/monitoring
    console-page: /observe/monitoring
    product-page: https://www.ibm.com/cloud/cloud-monitoring
    path: monitoring
    label: Monitoring
  entries:
  - navgroup:
      id: learn
      topics:
      - getting-started.md
      - topicgroup:
          label: About
          topics:
          - topic: about-monitor.md
            navtitle: Monitoring in IBM Cloud
          - topic: about-collect-metrics.md
            navtitle: Collecting metrics
          - topic: about-timeseries.md
            navtitle: Metrics and time-series
          - topic: monitor/monitoring.md
            navtitle: Viewing metrics
          - topic: monitor/alerts.md
            navtitle: Working with alerts and events
          - topic: features.md
            navtitle: Features
      - topicgroup:
          label: Monitoring IBM Cloud services
          topics:
          - topic: platform/platform_metrics_enabling.md
            navtitle: Enabling platform metrics
          - topic: platform/platform_metrics_working.md
            navtitle: Monitoring platform metrics
          - topic: platform/cloud_services.md
            navtitle: Services generating metrics
          - topic: platform/cloud_services_locations.md
            navtitle: Services generating metrics by location
      - topicgroup:
          label: Monitoring infrastructure
          topics:
          - topic: infrastructure/kubernetes_cluster.md
            navtitle: Monitoring a Kubernetes cluster
          - topic: infrastructure/openshift_cluster.md
            navtitle: Monitoring a Red Hat OpenShift cluster
          - topic: infrastructure/windows.md
            navtitle: Monitoring a Windows environment
          - topic: infrastructure/ubuntu.md
            navtitle: Monitoring a Linux VPC instance
          - topic: infrastructure/powervs.md
            navtitle: Monitoring a Linux host on PowerVS
          - topic: infrastructure/baremetal_linux.md
            navtitle: Monitoring a Linux baremetal server
          - topic: infrastructure/vmware.md
            navtitle: Monitoring a VMware deployment 
      - topicgroup:
          label: Collecting Prometheus metrics
          topics:
          - topic: prometheus/prometheus_remote_write.md
            navtitle: Metrics via Prometheus remote-write
          - topic: exporters/prometheus-exporters.md
            navtitle: Metrics via Prometheus exporters
          - topic: exporters/blackbox.md
            navtitle: Collecting availability metrics
          - topic: exporters/ipmi.md
            navtitle: Collecting IPMI device sensor metrics
          links:
          - link:
              label: Prometheus native metrics
              href: https://docs.sysdig.com/en/docs/sysdig-monitor/integrations-for-sysdig-monitor/collect-prometheus-metrics/
          - link:
              label: StatsD metrics
              href: https://docs.sysdig.com/en/docs/sysdig-monitor/integrations-for-sysdig-monitor/integrate-statsd-metrics/
          - link:
              label: JMX metrics
              href: https://docs.sysdig.com/en/docs/sysdig-monitor/integrations-for-sysdig-monitor/integrate-jmx-metrics-from-java-virtual-machines/
          - link:
              label: Node.js application metrics
              href: https://docs.sysdig.com/en/docs/sysdig-monitor/integrations-for-sysdig-monitor/integrate-node.js-application-metrics/
      - topic: monitor/data_streaming.md
        navtitle: Streaming metrics to Kafka
      - topicgroup:
          label: Sending notifications
          topics:
          - notifications/eventnotif_tutorial.md
          - notifications/eventnotif_sms_tutorial.md
      - about_wp.md
      - topicgroup:
          label: Release notes
          topics:
          - topic: releasenotes.md
            navtitle: Release notes
          - releasenotes_notifications.md
  - navgroup:
      id: howto
      topics:
      - topicgroup:
          label: Managing instances
          topics:
             - provision.md
             - terraform/terraform-setup.md
             - iam/iam_instance_auth.md
             - remove.md
             - upgrade.md
      - topicgroup:
          label: Managing keys
          topics:
             - iam/access_key.md
             - iam/api_token.md
             - iam/api_monitor_token.md
      - topicgroup:
          label: Controlling access
          topics:
          - iam/iam.md
          - iam/iam_grant.md
          - iam/iam_grant_team.md
          - iam/trusted_profiles.md
          - teams/teams.md
          - teams/team_id.md
      - topicgroup:
          label: Enhancing security
          topics:
          - core/cbr.md
          - core/data-security.md
          - topicgroup:
              label: Privately connecting to Monitoring
              topics:
              - core/service-connection.md
              - topic: core/vpe.md
                navtitle: Using virtual private endpoints
          - core/architecture-workload-isolation.md
      - topicgroup:
          label: Observability
          topics:
          - core/at_events.md
      - topicgroup:
          label: Monitoring resources
          topics:
          - launch.md
          - undock.md
          - get_sysdig_web_url.md
          links:
            - link:
                label: Using Explore
                href: https://docs.sysdig.com/en/explore.html
      - topicgroup:
          label: Monitoring agent
          topics:
          - topic: agent/agent_version.md
            navtitle: Listing agent versions
          - topic: agent/agent-types.md
            navtitle: Choosing an agent type by host
          - topic: agent/agent_version_host.md
            navtitle: Finding the agent version of a host
          - topic: agent/agent_ts_limits.md
            navtitle: Checking custom time series collected by a host
          - topicgroup:
              label: Orchestrated environments
              topics:
              - topic: agent/agent_image.md
                navtitle: Listing agent image versions
              - topic: agent/resource_requirements.md
                navtitle: Kubernetes resource requirements
              - topic: agent/agent-deploy-kube-helm.md
                navtitle: Managing the Kubernetes agent by using Helm
              - topic: agent/agent-deploy-openshift-helm.md
                navtitle: Managing the Red Hat OpenShift agent by using Helm
              - topic: agent/agent_nonibm.md
                navtitle: Managing non-IBM Cloud Kubernetes and Openshift clusters
              - topic: agent/agent_kube.md
                navtitle: Deploying the Kubernetes agent by using a script
              - topic: agent/agent_openshift.md
                navtitle: Deploying the Red Hat OpenShift agent by using a script
              - topic: agent/change_kube_agent.md
                navtitle: Customizing Kube agents
          - topicgroup:
              label: Non-orchestrated environments
              topics:
              - agent/agent_windows.md
              - topic: agent/agent_linux.md
                navtitle: Managing the Linux agent
              - topic: agent/manage_agent_linux_powervs.md
                navtitle: Managing the Linux agent on PowerVS
              - topic: agent/agent_linux_1.md
                navtitle: Deploying Linux agent with no public access
              - topic: agent/change_linux_agent.md
                navtitle: Customizing Linux agents
              - topic: agent/agent_docker.md
                navtitle: Managing the agent by using Docker containers
              - topic: agent/change_container_agent.md
                navtitle: Customize a Docker containerized agent
          - topic: agent/agent_log_level.md
            navtitle: Configuring the log level
          links:
            - link:
                label: Monitoring agent Release Notes
                href: https://docs.sysdig.com/en/sysdig-agent-release-notes.html
      - topicgroup:
          label: Working with metrics
          links:
            - link:
                label: Metrics dictionary
                href: https://docs.sysdig.com/en/metrics-dictionary.html
            - link:
                label: Working with metrics
                href: https://docs.sysdig.com/en/metrics.html
            - link:
                label: Grouping, Scoping, and Segmenting Metrics
                href: https://docs.sysdig.com/en/grouping,-scoping,-and-segmenting-metrics.html
            - link:
                label: Understanding Default, Custom, and Missing Metrics
                href: https://docs.sysdig.com/en/understanding-default,-custom,-and-missing-metrics.html
            - link:
                label: Managing the Metric Scale
                href: https://docs.sysdig.com/en/manage-metric-scale.html
            - link:
                label: Data Aggregation
                href: https://docs.sysdig.com/en/data-aggregation.html
            - link:
                label: Metric Limits
                href: https://docs.sysdig.com/en/metric-limits.html
            - link:
                label: Prometheus metrics / OpenMetrics code instrumentation
                href: https://sysdig.com/blog/prometheus-metrics/
          topics:
          - monitor/mng_metrics.md
          - api/metrics_api.md
          - api/metrics_python.md
          - exporters/promql.md
      - topicgroup:
          label: Working with metrics in non-supported locations
          topics:
          - topic: manage-metrics-for-new-region.md
            navtitle: Working with metrics before a region is available
          - topic: manage-metrics-to-new-region.md
            navtitle: Working with metrics after a region is open for business
      - topicgroup:
          label: Integrations
          links:
            - link:
                label: Configure a Prometheus data source with Grafana
                href: https://docs.sysdig.com/en/configure-sysdig-with-grafana.html
      - topicgroup:
          label: Dashboards
          topics:
          - monitor/dashboards.md
          - monitor/panels.md
          - api/dashboard_api.md
          - api/dashboard_python.md
          links:
            - link:
                label: Dashboard library
                href: https://docs.sysdig.com/en/docs/sysdig-monitor/dashboards/dashboard-templates/
      - topicgroup:
          label: Working with alerts
          topics:
          - topicgroup:
              label: Alert types
              topics:
              - monitor/alert-metric.md
              - monitor/alert-change.md
              - monitor/alert-downtime.md
              - monitor/alert-event.md
              - monitor/alert-promql.md
          - topicgroup:
              label: Configuring and managing alerts
              topics:
              - monitor/alert-config-legacy.md
              - monitor/alert-config.md
              - monitor/alert-manage.md
              - monitor/alert-library.md
              - monitor/alert-silence.md
          - api/alert_api.md
          - api/alert_python.md
          - api/metrics_sent_eventstreams.md
          - monitor/notifications.md
          - api/notifications_api.md
          - monitor/pd_sms.md
          - monitor/eventnotif.md
          - monitor/eventnotif_sms.md
      - topicgroup:
          label: Events
          links:
            - link:
                label: Working with custom events
                href: https://docs.sysdig.com/en/docs/sysdig-monitor/events/event-types/custom-events/
      - topicgroup:
          label: Captures
          links:
            - link:
                label: Working with captures
                href: https://docs.sysdig.com/en/captures.html
          topics:
          - monitor/captures.md
  - navgroup:
      id: reference
      topics:
      - regions.md
      - endpoints.md
      - service_plans.md
      - pricing.md
      - collect-metrics-by-host.md
      - agent_support.md
      - core/shared-responsibilities.md
      - topic: core/ha-dr.md
        navtitle: Understanding high availability and disaster recovery
      - topic: core/data-portability.md
        navtitle: Data portability
      - topicgroup:
          label: Monitoring CLI
          topics:
          - include: ../monitor-cli-plugin/monitor-cli.md
      - topicgroup:
          label: Monitoring API
          links:
              - link:
                  label: Monitoring API
                  href: https://{DomainName}/apidocs/monitor
          topics:
          - api/mon-curl.md
          - api/python-client.md
      - topicgroup:
          label: Terraform
          links:
              - link:
                  label: Terraform information
                  href: https://registry.terraform.io/providers/sysdiglabs/sysdig/latest/docs
      - topicgroup:
          label: Prometheus
          links:
              - link:
                  label: Prometheus metrics / OpenMetrics code instrumentation
                  href: https://sysdig.com/blog/prometheus-metrics/
      - topicgroup:
          label: Metrics
          links:
              - link:
                  label: Metrics dictionary
                  href: https://docs.sysdig.com/en/metrics-dictionary.html

      - deprecated.md

  - navgroup:
        id: help
        topics:
        - gettinghelp.md
        - monitor/troubleshoot.md
        - monitor/faq.md