CircleCI plugin

Click the following link for additional content such as blogs, videos, use cases, and more:

CircleCI

Monitor the Pipelines and Workflows from your CircleCI environment.

Adding a data source

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

Before you start

Create a personal API token in CircleCI

See Managing API Tokens

Configuring the data source

  1. Personal API Token:
    Paste in the API token you created in CircleCI.

  2. Restrict access to this data source:
    Optionally, enable this toggle if you only want certain users/groups to have access to the data source, or those with the permission to link it to new workspaces. See data source access control for more information.

  3. Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.

    • Testing passed – a success message will be displayed and then the configuration will be saved.
    • Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
    • Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

    You can edit data source configurations at any time from Settings > Data Sources.

Next steps

Data streams

You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.

Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.

While creating a tile you can tweak data streams by grouping or aggregating specific columns.

Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.

Data streams can be either global or scoped:

  • Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
  • A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

See Data Streams for more information.

The following data streams are installed with this plugin.

Data stream
Description
Organization Summary
Get the Insight summary for an Organization or set of Organizations
Project Summary
Get the Insight summary for the projects in an Organization or set of Organizations

Configurable data streams

The following data streams installed with this plugin have configurable Parameters.

Data stream
Description
Parameters
Pipelines
Get the most recent pipelines for a project
  1. Most recent only:
    Select to return only the most recent pipeline.
Workflow Summary Metrics
Get the workflow summary metrics for a project or set of projects
  1. All Branches:
    Select to return data from all branches, leave deselected to only return data from the default branch.
Workflow Runs
Get the most recent workflow runs for a project
  1. All Branches:
    Select to return data from all branches, leave deselected to only return data from the default branch.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket