Configure Default Integrations
Prerequisites
- PromScrape version 2. See Migrating from Promscrape V1 to V2.
Default Integrations
Sysdig provides default integrations for applications in the Integrations Library. For example: Application integrations, cloud integrations, and infrastructure integrations.
Default integrations collect metrics from a source and send them to Sysdig Monitor. The metrics Sysdig collects by default have been chosen for their value in building Dashboards and creating Alerts. To collect additional metrics or remove metrics from collection, see Customize a Default Job.
To limit metric collection to specific clusters, see Exlude Clusters from Collecton.
Supported Monitoring Integrations
Integrations can be:
- Enabled by default: The integration will start reporting metrics as soon as the Sysdig Agent detects the application. You do not need to manually enable this type of integration. See Enable and Disable Integrations.
- Out of the box: The integration requires no exporter or extra configuration to retrieve metrics from the application. See Configure an Integration.
Sysdig supports the following default integrations:
Integration | Out of the Box | Enabled by default | Job name in config file |
---|---|---|---|
Apache | ✔ | apache-exporter-default, apache-grok-default | |
Calico | ✔ | calico-node-default, calico-controller-default | |
Cassandra | ✔ | cassandra-default | |
Ceph | ✔ | ✔ | ceph-default |
Consul | ✔ | ✔ | consul-server-default, consul-envoy-default |
Elasticsearch | ✔ | elasticsearch-default | |
Fluentd | ✔ | ✔ | fluentd-default, openshift-fluentd-default |
HAProxy Ingress | ✔ | ✔ | haproxy-default |
HAProxy Ingress OpenShift | ✔ | ✔ | haproxy-router |
Harbor | ✔ | ✔ | harbor-exporter-default, harbor-core-default, harbor-registry-default, harbor-jobservice-default |
IBM Kubernetes API Server | ✔ | iks-apiservers-default | |
Istio | ✔ | ✔ | istiod |
Kubernetes API server | ✔ | kubernetes-apiservers-default | |
K8s cAdvisor | ✔ | ✔ | k8s-cadvisor-default |
Kubernetes controller manager | ✔ | ✔ | kube-controller-manager-default |
Kubernetes CoreDNS | ✔ | ✔ | kube-dns-default |
Kubernetes etcd | ✔ | ✔ | etcd-default, etcd-legacy-default |
Kubernetes kubelet | ✔ | k8s-kubelet-default | |
Kubernetes kube-proxy | ✔ | kubernetes-kube-proxy-default | |
Kubernetes PVC | ✔ | k8s-pvc-default | |
Kubernetes Scheduler | ✔ | ✔ | kube-scheduler-default |
Kubernetes storage | ✔ | k8s-storage-default | |
Kafka | ✔ | kafka-exporter-default, kafka-jmx-default | |
KEDA | ✔ | ✔ | keda-default |
Knative | ✔ | ✔ | knative-operator-default, knative-serving-controller-default, knative-serving-autoscaler-default, knative-serving-activator-default, knative-serving-webhook-default, knative-eventing-broker-filter-default, knative-eventing-broker-ingress-default, knative-eventing-controller-default, knative-eventing-imc-controller-default, knative-eventing-imc-dispatcher-default, knative-eventing-apiserver-source-default |
Memcached | ✔ | memcached-default | |
MongoDB | ✔ | mongodb-default | |
MySQL | ✔ | mysql-default | |
NGINX | ✔ | nginx-default | |
NGINX Ingress | ✔ | ✔ | nginx-ingress-default |
NTP | ✔ | ntp-default | |
OPA | ✔ | ✔ | opa-default |
OpenShift API-Server | ✔ | openshift-apiserver-default | |
OpenShift Controller Manager | ✔ | ✔ | openshift-controller-manager-default |
OpenShift CoreDNS | ✔ | ✔ | openshift-dns-default |
OpenShift Etcd | ✔ | openshift-etcd-default | |
OpenShift Scheduler | ✔ | ✔ | openshift-scheduler-default |
OpenShift State Metrics | ✔ | ✔ | openshift-state-metrics |
OracleDB | ✔ | oracledb-exporter-default | |
PHP-FPM | ✔ | php-fpm-default | |
Portworx | ✔ | ✔ | portworx-default, portworx-openshift-default |
PostgreSQL | ✔ | postgres-default | |
Prometheus Default Job | ✔ | ✔ | k8s-pods |
RabbitMQ | ✔ | ✔ | rabbitmq-default |
Rancher RKE API Server | ✔ | rancher-rke-api-server-default | |
Rancher RKE Controller Manager | ✔ | rancher-rke-controller-manager-default | |
Rancher RKE CoreDNS | ✔ | rancher-rke-coredns-default | |
Rancher RKE Kube Proxy | ✔ | rancher-rke-kube-proxy-default | |
Rancher RKE Scheduler | ✔ | rancher-rke-scheduler-default | |
Rancher RKE2 API Server | ✔ | rancher-rke2-api-server-default | |
Rancher RKE2 Controller Manager | ✔ | rancher-rke2-controller-manager-default | |
Rancher RKE2 CoreDNS | ✔ | rancher-rke2-coredns-default | |
Rancher RKE2 Etcd | ✔ | rancher-rke2-etcd-default | |
Rancher RKE2 Kube Proxy | ✔ | rancher-rke2-kube-proxy-default | |
Rancher RKE2 Scheduler | ✔ | rancher-rke2-scheduler-default | |
Redis | ✔ | redis-default | |
Redis Enterprise | ✔ | ✔ | redis-enterprise-default |
Sysdig Admission Controller | ✔ | ✔ | sysdig-admission-controller-default |
Enable and Disable Integrations
Some integrations are not enabled by default due to the potential high cardinality of their metrics. To enable or disable integrations:
Steps | Preview |
---|---|
Navigate to the Monitoring Integrations page (Integrations > Monitoring Integrations). | |
Select any integration (here, it’s Kubernetes API server), and click Manage this integration. | |
Set the integration to enabled or disabled, as desired, and click Confirm. You can also add Exceptions to exclude specific clusters from the general rule. |
Configure an Integration
Some default integrations require configuration, such as installing an exporter, to collect metrics. These workloads will appear under the Requires Configuration list. To configure:
Click on one of the workloads listed under Requires Configuration.
A wizard appears.
Ensure the instance has been correctly identified. If you suspect Sysdig has misidentified the instance, click Configure another integration and choose the correct integration from the integration library. If your integration is not available, you may need to create a custom configuration, see Custom Integrations
If it is correct, click Start Configuration.
The wizard provides instructions, including code snippets and configuration details, for each type of default integration. Follow all the steps provided by the wizard, and once you’re finished, click Close.
Some configurations involve setting up an exporter. To customize an exporter, see Add Sysdig Annotations in Exporters.
Customize a Default Job
The default jobs offered by Sysdig for integrations are optimized to scrape the metrics for building dashboards and alerts in Sysdig Monitor. However, you may wish to manually configure which metrics are collected.
To overwrite a default job:
Locate the
prometheus.yaml
file in thesysdig-agent
ConfigMap in thesysdig-agent
namespace.Consult the Integrations Library for the complete list of default integrations. Find the default agent job in the Agent Configuration section. See, for example, Cassandra Agent Configuration.
Add a new job to the
prometheus.yaml
file with the same name as the default job you want to replace. For example, if you want to create a new job for the Cassandra integration, create a new job with the namecassandra-default
.Jobs defined by the user have precedence over the default ones.
Annotate Exporters to Collect Metrics
Sysdig provides a set of Helm charts that helps you configure the exporters for the integrations. Helm charts are publicly available in the Sysdig Helm repository.
If exporters are already installed in your cluster, you can use the standard Prometheus annotations and the Sysdig agent will automatically scrape them.
To collect metrics from an exporter, add this annotation:
spec:
template:
metadata:
annotations:
prometheus.io/path: /metrics
prometheus.io/port: '9100'
prometheus.io/scrape: 'true'
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.