Versions Compared

Version Old Version 7 New Version Current
Changes made by

Susmita Bhattacharjee (Unlicensed)

Susmita Bhattacharjee (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A listening webhook can be configured in Insights where Spinnaker will forward payloads with event details whenever any event(viz. pipeline execution, cluster deletion etc.) occurs through the Spinnaker UI. The echo-rest module in spinnaker is used to set downstream listeners to keep track of Spinnaker events. It will forward any event received from Orcaorca, igor or echo to the webhooks registered.

...

Expand
titleStep 2. Integrate the webhook to Spinnaker:

  1. Login to the halyard instance from where you have deployed Spinnaker. Navigate to the following path:

    ~/.hal/default/profiles

  2. Create a new file here called: echo-local.yml

  3. Write the content below into your newly created echo-local.yml file:

    Code Block
    rest:
  enabled: true
  endpoints:
    -
      wrap: false
      url: <Insights_Webhook_Configured_In_Step_1>

  4. Save the file and run the following command:

    hal deploy apply

Info

This will redeploy Spinnaker with your changes, and all event payloads will be forwarded to the InSights webhook.

You can configure multiple webhooks, where Spinnaker will forward the payloads to all of them simultaneously. In such scenarios, the echo-local.yml file will look like this:

rest:
enabled: true
endpoints:
-
wrap: false
url: <webhook1>
-
wrap: false
url: <webhook2>

Reference: click here

...

Default Spinnaker Dashboards

Upon configuring the webhook, the data flowing into InSights can be represented into meaningful Key Performance Indicators, which can provide a holistic view of the activities inside Spinnaker. We have used Grafana to depict a few such KPIs as graphical panels that might be useful for business analysis. Below are the KPI’s available:

  1. Total number of Deployments:

Signifies the total number of deployments done via Spinnaker with (pass/fail distribution) as a doughnut chart.

...

2. Monthly Deployments over time:

Number of deployments happening each month, along with passed/failed deployment distribution.

...

3. Application Details:

Table containing application names, pipelines executed that are part of the said applications, number of times the pipelines are executed and the distinct outcomes of such executions.

...

4. Pipeline Execution Details:

Tabular panel containing the details of each pipeline execution (eg- name, status, Date and time of execution etc.)

...

5. Average Deployment Time:

Time taken to complete a deployment (pipeline execution) along with the overall average time (in minutes).

...

6. Canary Analysis Panels:

  • Top 10 Canary Pipelines:

Top 10 pipelines (according to their time of execution) and their execution status.

...

  • Canary Overview:

Details of canary pipeline executions (eg – execution status, canary scrore, score boundaries etc.)

...