Configure Monitoring

Configure monitoring using the Observability Plugin

Configure monitoring using the Observability Plugin

Armory recommends that you monitor your systems by using the Armory Observability Plugin. This is an open source solution for monitoring Armory Enterprise. The plugin supports the following:

  • Adding Prometheus (OpenMetrics) endpoints to Armory Enterprise pods.
  • Sending data to NewRelic (see the plugin’s README).

The Observability Plugin removes the service name from the metric. This is incompatible with the behavior of the open source Spinnaker monitoring daemon system, which was the default monitoring solution in versions earlier than 2.20 and is now deprecated.

Install the plugin

You have two options for installing the Observability plugin:

  • Add the plugin configuration for all services the spinnaker profile section.
  • Add the plugin configuration to only the services you want to monitor.

The following example adds the Observability Plugin configuration for all services to the spinnaker-local.yml file and enables Prometheus:

# These lines are spring-boot configuration to allow access to the metrics
# endpoints.  This plugin adds the "aop-prometheus" endpoint on the
# "<service>:<port>/aop-prometheus" path.

management:
  endpoints:
    web:
      # Read the security warning at the start of this section about what gets exposed!!
      exposure.include: health,info,aop-prometheus
spinnaker:
  extensibility:
    plugins:
      Armory.ObservabilityPlugin:
        enabled: true
        version: <VERSION>
        # This is the basic configuration for prometheus to be enabled
        config.metrics:
          prometheus:
            enabled: true
    repositories:
      armory-observability-plugin-releases:
        url: https://raw.githubusercontent.com/armory-plugins/armory-observability-plugin-releases/master/repositories.json

You can find more options for management endpoints and the plugin in the plugin’s README.


Last modified July 20, 2022: (83f09a7)