Operational Analytics Plugin for Spinnaker

The Operational Analytics Plugin for Spinnaker and Armory Continuous Deployment automates the aggregation of successful pipeline count by day and makes the information available to query and visualize through an API.

Proprietary

What the Operational Analytics plugin does

Armory’s Operational Analytics plugin for Spinnaker and Armory CD adds functionality to Orca that enables the storage of new metrics in Orca. You can retrieve those metrics using the API. The plugin is designed to provide key performance indicators without adding more services or operational overhead to the Spinnaker cluster to which it is installed.

Before you begin

Your Orca service must use a SQL backend. See Orca configured with SQL backend for instructions.
You’re able to call Orca’s service endpoint (by default http://spin-orca:8083)

Compatibility matrix

Armory CD Version	Spinnaker Version	Armory Insights Plugin Version
2.31.x	1.31.x	1.0.0
2.30.x	1.29.x, 1.30.x	1.0.0
2.28.x	1.28.x	1.0.0

Install the plugin

In your spinnaker-kustomize-patches/plugins directory, create an operational-analytics-plugin.yml file with the following contents:

apiVersion: spinnaker.armory.io/v1alpha2
kind: SpinnakerService
metadata:
  name: spinnaker
spec:
  spinnakerConfig:
    profiles:
      spinnaker:
        insights:
          jobs:
            pipelineStatusCount:
              cron: '1 1 1 * * *'              
        spinnaker:
          extensibility:
            repositories:
              repository:
                enabled: true
                url: https://raw.githubusercontent.com/armory-plugins/pluginRepository/master/repositories.json
      orca:
        spinnaker:
          extensibility:
            plugins:
              Armory.Insights:
                version: <version>
                enabled: true
              extensions:
                armory.insights:
                  enabled: true

version: Replace <version> with the plugin version compatible with your Spinnaker version.
insights.jobs.pipelineStatusCount.cron: Replace with a cron expression that corresponds to the time of the day with lowest load. You can disable this field by using - as the expression. For example:

spec:
 spinnakerConfig:
   profiles:
     spinnaker:
       insights:
         jobs:
           pipelineStatusCount:
             cron: '-'

Add the plugin patch to your Kustomize recipe’s patchesStrategicMerge section. For example:

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

namespace: spinnaker

components:
  - core/base
  - core/persistence/in-cluster
  - targets/kubernetes/default

patchesStrategicMerge:
  - core/patches/oss-version.yml
  - plugins/operational-analytics-plugin.yml

patches:
  - target:
      kind: SpinnakerService
    path: utilities/switch-to-oss.yml

Apply the updates to your Kustomization recipe.

kubectl apply -k <kustomization-directory-path>

In your spinnaker-kustomize-patches/plugins/oss directory, create an operational-analytics-plugin.yml file with the following contents:

apiVersion: spinnaker.io/v1alpha2
kind: SpinnakerService
metadata:
  name: spinnaker
spec:
  spinnakerConfig:
    profiles:
      spinnaker:
        insights:
          jobs:
            pipelineStatusCount:
              cron: '1 1 1 * * *'              
        spinnaker:
          extensibility:
            repositories:
              repository:
                enabled: true
                url: https://raw.githubusercontent.com/armory-plugins/pluginRepository/master/repositories.json
      orca:
        spinnaker:
          extensibility:
            plugins:
              Armory.Insights:
                version: <version>
                enabled: true
              extensions:
                armory.insights:
                  enabled: true

version: Replace <version> with the plugin version compatible with your Spinnaker version.
insights.jobs.pipelineStatusCount.cron: Replace with a cron expression that corresponds to the time of the day with lowest load. You can disable this field by using - as the expression. For example:

spec:
 spinnakerConfig:
   profiles:
     spinnaker:
       insights:
         jobs:
           pipelineStatusCount:
             cron: '-'

Add the plugin patch to your Kustomize recipe’s patchesStrategicMerge section.

For example:

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

namespace: spinnaker

components:
  - core/base
  - core/persistence/in-cluster
  - targets/kubernetes/default

patchesStrategicMerge:
  - core/patches/oss-version.yml
  - plugins/oss/operational-analytics-plugin.yml

patches:
  - target:
      kind: SpinnakerService
    path: utilities/switch-to-oss.yml

Apply the updates to your Kustomization recipe.

kubectl apply -k <kustomization-directory-path>

The Operational Analytics plugin extends Orca. You should create or update the extended service’s local profile in the same directory as the other Halyard configuration files. This is usually ~/.hal/default/profiles on the machine where Halyard is running.

insights:
  jobs:
    pipelineStatusCount:
      cron: '1 1 1 * * *' 
      
spinnaker:
  extensibility:
    plugins:
      Armory.Insights:
        version: <version>
          enabled: true
      extensions:
        armory.insights:
          enabled: true
      repositories:
        repository:
          enabled: true
          url: https://raw.githubusercontent.com/armory-plugins/pluginRepository/master/repositories.json

version: Replace <version> with the plugin version compatible with your Spinnaker version.
insights.jobs.pipelineStatusCount.cron: Replace with a cron expression that corresponds to the time of the day with lowest load. You can disable this field by using - as the expression. For example:

insights:
  jobs:
    pipelineStatusCount:
      cron: '-'

Save your file and apply your changes by running hal deploy apply.

How to use the plugin

API endpoint

/insights/pipelines/statuses/count

Parameter	Type	Description	Optional	Default Value
from	Date (yyyy-MM-dd)	Starting Date	Yes	30 days ago
to	Date (yyyy-MM-dd)	End Date	Yes	Today
limit	Number	Max Number of results	Yes	1000
offsetId	Number	Starting Id (Exclusive)	Yes	nil
descOrder	Boolean	Sort results in descending order	Yes	false
status	SUCCEEDED \| TERMINAL	Status of the aggregate	Yes	SUCCEEDED

JSON Response

{
    "records": [
        {
            "id": [id],
            "status": "[status]",
            "date": [UNIX milliseconds],
            "count": [count],
            "day": "yyyy-MM-dd"
        },
        ...
    ],
    "limit": [limit],
    "count": [count],
    "from": "yyyy-MM-dd",
    "to": "yyyy-MM-dd"
}

Root object

Field	Type	Description
records	Array	Array of record objects
limit	Number	Limit on the number of records
count	Number	Total number of records
from	String	Start date for the record collection
to	String	End date for the record collection

Record object

Each object in the records array has the following structure:

Field	Type	Description
id	Number	Unique identifier of the record
status	String	Status of the record (e.g., “SUCCEEDED”)
date	Number	Date of the record in milliseconds since epoch
count	Number	Count associated with the record
day	String	The day corresponding to the record (yyyy-MM-dd format)

Feedback

Was this page helpful?

Thank you for letting us know!

Sorry to hear that. Please tell us how we can improve.

Last modified December 13, 2023: (69a0e06c)