Observability Plugin

Observability Plugin is used to pull metrics directly from Spinnaker microservices. This plugin increases performance, reduces system load, and provides additional features such as metric filtering.

The Observability plugin works in two key ways:

  • It enables customizing the Micrometer registry.

  • It exposes an OpenMetrics endpoint for the Micrometer/Spectator metrics, allowing tools such as Prometheus or platforms that query open metrics formats to work without needing a sidecar.

These allow for key improvements in Spinnaker observability, such as removing the service name for each metric so that you can more easily organize and filter metrics for cross-Spinnaker visibility. They also create a more efficient implementation and dramatically reduce CPU and memory usage.

Following is the sequence of activities for enabling the Observability Plugin:

  • Update Spinnaker Images

  • Configuration to Enable Observability Plugin

Update the Spinnaker Images

To enable the Observability Plugin metrics we need to update all the spinnaker images with permissions enabled for the Plugin Directory as instructed below:

  1. Navigate to default/profiles/service-settings

  2. Update all the below images as per the service:

    artifactId: quay.io/opsmxpublic/ubi8-oes-spin-gate:v3.12.0
    artifactId: quay.io/opsmxpublic/ubi8-spin-igor:v3.12-opt
    artifactId: quay.io/opsmxpublic/ubi8-spin-rosco:v3.12-opt
    artifactId: quay.io/opsmxpublic/ubi8-spin-kayenta:v3.12-opt
    artifactId: quay.io/opsmxpublic/ubi8-spin-echo:v3.12-opt
    artifactId: quay.io/opsmxpublic/ubi8-oes-front50:v3.12-opt
    artifactId: quay.io/opsmxpublic/ubi8-spin-fiat:v3.12-opt
    artifactId: quay.io/opsmxpublic/ubi8-spin-clouddriver:tag-version-8.0.4-apl-shard-all-fix-dockertag-cli

Configuration Update to Enable Observability Plugin

Below configuration instructions need to be followed to Enable Observability Plugin.

  1. Clone the repo by using the below command.

    git clone https://github.com/OpsMx/Redis-For-Clouddriver.git

  2. After cloning the above repo, Navigate to “ObservabilityPluginConfiguration” directory and copy the configurations from all the files.

    Note: Ensure to Compare the yaml with your current existing configurations and do not overwrite any existing change. Just Copy the Plugin Part

  3. Update the configuration for all the spinnaker services in order to capture the metrics for every service individually.

  4. Navigate to default/profiles.

  5. Edit each Individual service-local yaml file and update the below data into it.

        plugins-root-path: /opt/clouddriver/plugins
            enabled: true
                  service: spin-clouddriver-caching
                  enabled: true
                    armoryRecommendedFiltersEnabled: true
            url: https://raw.githubusercontent.com/armory-plugins/armory-observability-plugin-releases/master/repositories.json
          # Read the security warning at the start of this section about what gets exposed!!
          exposure.include: health,info,aop-prometheus
  6. Restart the halyard pod, after updating the above changes.

Last updated