Cloudsmith

Supported OS Linux Windows Mac OS

Integration version0.0.2

Overview

This check monitors Cloudsmith through the Datadog Agent.

  • Monitor storage, bandwidth and token usage in your Cloudsmith account.

Setup

The Cloudsmith check is not included in the Datadog Agent package, so you need to install it.

Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the Cloudsmith check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.

  1. Run the following command to install the Agent integration:

    datadog-agent integration install -t datadog-cloudsmith==<INTEGRATION_VERSION>
    
  2. Configure your integration similar to core integrations.

Configuration

  1. Edit the cloudsmith.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Cloudsmith performance data. See the sample cloudsmith.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for cloudsmith under the Checks section.

Data Collected

Metrics

cloudsmith.storage_used
(gauge)
The percentage of storage used
Shown as percent
cloudsmith.bandwidth_used
(gauge)
The percentage of bandwidth used
Shown as percent
cloudsmith.token_count
(gauge)
The number of tokens in an organization
Shown as item
cloudsmith.token_bandwidth_total
(gauge)
The total bandwidth used by tokens
Shown as byte
cloudsmith.token_download_total
(gauge)
The total downloads used by tokens
Shown as item

Events

All Cloudsmith related events collected appear within the Datadog Event Stream with the source:cloudsmith property. They are collected every five minutes to reduce the number of requests sent to the Cloudsmith API.

There are two types of events:

  • Security Scan event
  • Audit Logs event

They are accessible with aggregation keys: @aggregation_key:audit_log and @aggregation_key:vulnerabilities.

Troubleshooting

Need help? Contact Cloudsmith support.

PREVIEWING: esther/docs-9478-fix-split-after-example