From 4b680d0f0af36de0649d5146d2473d6113f2214d Mon Sep 17 00:00:00 2001 From: NimRegev Date: Mon, 18 Jul 2022 14:35:57 +0300 Subject: [PATCH 1/6] Add manage pipelines --- _docs/pipelines/managing-pipelines.md | 171 ++++++++++++ _docs/pipelines/workflows.md | 381 +++++++++++++++++--------- 2 files changed, 415 insertions(+), 137 deletions(-) create mode 100644 _docs/pipelines/managing-pipelines.md diff --git a/_docs/pipelines/managing-pipelines.md b/_docs/pipelines/managing-pipelines.md new file mode 100644 index 000000000..77e1779b8 --- /dev/null +++ b/_docs/pipelines/managing-pipelines.md @@ -0,0 +1,171 @@ +--- +title: "Managing pipelines" +description: "" +group: pipelines +toc: true +--- + +Once a Delivery Pipeline is [created and triggered]({{site.baseurl}}/docs/pipelines/create-pipeline/),Codefresh continuously collects and displays real-time analytics on the pipeline and the workflows submitted. +>This article focuses on pipeline management. For information on managing workflows in pipelines, see [Managing workflows]({{site.baseurl}}/docs/pipelines/workflows/). + + +Manage Delivery Pipelines in Codefresh by monitoring pipeline performance and analytics, and by optimizing pipeline configurations and manifests. + + +**Monitoring pipeline performance and analytics** +Monitor pipelines performance at the global and individual levels. Both levels provide metrics for KPIs for insights into trends and performance. + +* At the global level (Home dashboard), Codefresh aggregates performance analytics for all pipelines with active workflows. +* At the individual level (Delivery Pipelines list), Codefresh aggregates performance based on the pipeline's workflows, including step analytics across all the workflows in the pipeline. Step analytics allow you to analyze the resources consumed by a pipeline. +* Monitoring sensor and event-source errors for + + +**Optimizing pipeline configuration** +Use insights and trends from performance and KPI metrics to optimize the pipeline's Workflow Template, trigger conditions, and arguments. + + + + + + + +### Monitor sensor and event source notifications for pipelines in Activity Log +Monitor logs for sensors and event-sources in pipelines in the Activity Log. A pull-down panel in the Codefresh toolbar, the Activity Log shows ongoing, success, and error notifications, by date, starting with today's date. Syntax errors that prevent the sensor from triggering the pipeline are displayed here. + +1. In the Codefresh UI, on the top-right of the toolbar, select ![](/images/pipeline/monitoring/pipeline-activity-log-toolbar.png?display=inline-block) **Activity Log**. +1. To see pipeline activity, select **Event Source** and **Sensor** filters. + + {% include image.html + lightbox="true" + file="/images/pipeline/monitoring/monitor-activity-log.png" + url="/images/pipeline/monitoring/monitor-activity-log.png" + alt="Activity Log filtered by Event Source and Sensor" + caption="Activity Log filtered by Event Source and Sensor" + max-width="30%" + %} + +{:start="3"} +1. To see more information on an error, select the **+** sign. + +### Monitor global pipeline performance +Monitor performance of all active pipelines in the Home dashboard. Active pipelines are those that have at least one active or complete workflow. +The KPI metrics provides insights into trends for pipelines. Analytics are derived by comparing the selected time range to the corresponding reference period. If your time range is the last seven days, the reference period is the seven days that precede the time range. + + +1. In the Codefresh UI, go to the [Home](https://g.codefresh.io/2.0/){:target="\_blank"} page. +1. Set the **Time** frame for which to show pipeline data, as the **Last 7 days** (the default), **Last 30 days**, or **Last 90 days**. +1. Scroll down to Delivery Pipelines: + 1. To customize the view, select **Filters**. + 2. To switch to individual pipeline view, select **View**. + 3. To get day-to-day data for a metric, select the line-chart. + +Here is an example of the global pipeline view in the Home page. + + {% include image.html + lightbox="true" + file="/images/pipeline/monitoring/monitor-aggregated-view.png" + url="/images/pipeline/monitoring/monitor-aggregated-view.png" + alt="Global analytics for Delivery Pipelines in Home page" + caption="Global analytics for Delivery Pipelines in Home page" + max-width="30%" + %} + + + + +#### Filters for global pipeline view +Filters narrow the scope of aggregated data, allowing you to focus on the information you want to see. Unless otherwise indicated, all filters support multi-selection. + +{: .table .table-bordered .table-hover} +| Filter | Description| +| -------------- | --------------| +| **Status** | {::nomarkdown}