Overview
Cloudsmith is a fully managed cloud-native package management platform, used to securely store, manage, and distribute software artifacts for DevOps teams. It supports all major formats including Docker, npm, Maven, Python, RubyGems, and more, with enterprise-grade access control, policy enforcement, and auditing.
This integration enhances visibility into your Cloudsmith organization by collecting real-time observability data and surfacing it within the Datadog platform. Teams can monitor resource usage, enforce security compliance, and audit user activity-directly from within Datadog dashboards and monitors.
The integration collects data from Cloudsmith’s APIs and maps them to the following Datadog telemetry types:
- Metrics: Storage and bandwidth usage, repository-level storage/package/download counters, token activity, and active user metrics.
- Events: Security vulnerability findings, audit log activity, license and vulnerability policy violations, member summaries, and quota usage snapshots.
- Service Checks: Health status of quota consumption and API connectivity.
With this integration, customers gain centralized observability over their Cloudsmith package infrastructure, helping enforce compliance, troubleshoot issues faster, and optimize resource planning.
Setup
The Cloudsmith check is not included in the Datadog Agent package, so you need to install it.
Org-wide realtime bandwidth metrics are enabled by default and can be controlled with enable_realtime_bandwidth. The analytics interval defaults to five_minutes via bandwidth_interval.
Repository metrics from the Cloudsmith repositories endpoint are tagged with repository:<slug>, so users can filter dynamically in Datadog (for example, selecting one or two repositories from the repository dashboard template variable) without calling a separate per-repository endpoint.
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.
Run the following command to install the Agent integration:
datadog-agent integration install -t datadog-cloudsmith==1.3.0
Configure your integration similar to core integrations.
Configuration
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.
Example snippet with recommended defaults and profile filtering:
- url: https://api.cloudsmith.io/v1
cloudsmith_api_key: <API-KEY>
organization: <ORG-NAME>
enable_realtime_bandwidth: true
bandwidth_interval: five_minutes
bandwidth_profiles:
- name: prod-python
aggregate: bytes_downloaded_sum
repository:
- production
package_format:
- python
- name: by-country
aggregate: request_count
country:
- US
- GB
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) | [Deprecated] The number of tokens in an organization Shown as item |
cloudsmith.token_bandwidth_total (gauge) | [Deprecated] The total bandwidth used by tokens Shown as byte |
cloudsmith.token_download_total (gauge) | [Deprecated] The total downloads used by tokens Shown as item |
cloudsmith.storage_used_bytes (gauge) | The amount of storage used in bytes Shown as byte |
cloudsmith.bandwidth_used_bytes (gauge) | The amount of bandwidth used in bytes Shown as byte |
cloudsmith.repository.storage_bytes (gauge) | Current storage usage for a repository in bytes Shown as byte |
cloudsmith.repository.package_count (gauge) | Number of packages in the repository Shown as item |
cloudsmith.repository.download_count (gauge) | Total package downloads for the repository Shown as item |
cloudsmith.member.active (gauge) | The number of active members in the organization Shown as item |
cloudsmith.license_policy_violation.count (gauge) | The number of license policy violations Shown as item |
cloudsmith.vulnerability_policy_violation.count (gauge) | The number of vulnerability policy violations Shown as item |
cloudsmith.member.has_2fa.count (gauge) | The number of members with 2FA enabled Shown as item |
cloudsmith.member.saml.count (gauge) | The number of members who logged in with SAML Shown as item |
cloudsmith.member.password.count (gauge) | The number of members who logged in with password Shown as item |
cloudsmith.member.owner.count (gauge) | The number of users with role ‘Owner’ Shown as item |
cloudsmith.member.manager.count (gauge) | The number of users with role ‘Manager’ Shown as item |
cloudsmith.member.readonly.count (gauge) | The number of users with role ‘ReadOnly’ Shown as item |
cloudsmith.member.admin.count (gauge) | The number of users with role ‘Admin’ Shown as item |
cloudsmith.bandwidth_plan_limit_bytes (gauge) | The bandwidth limit in bytes defined by the plan Shown as byte |
cloudsmith.bandwidth_plan_limit_gb (gauge) | The bandwidth limit in gigabytes defined by the plan Shown as byte |
cloudsmith.bandwidth_used_gb (gauge) | The bandwidth used in gigabytes Shown as byte |
cloudsmith.storage_plan_limit_bytes (gauge) | The storage limit in bytes defined by the plan Shown as byte |
cloudsmith.storage_plan_limit_gb (gauge) | The storage limit in gigabytes defined by the plan Shown as byte |
cloudsmith.storage_used_gb (gauge) | The storage used in gigabytes Shown as byte |
cloudsmith.storage_configured_bytes (gauge) | The configured storage in bytes, including plan and overage Shown as byte |
cloudsmith.storage_configured_gb (gauge) | The configured storage in gigabytes, including plan and overage Shown as byte |
cloudsmith.bandwidth_configured_gb (gauge) | The configured bandwidth in gigabytes, including plan and overage Shown as byte |
cloudsmith.bandwidth_configured_bytes (gauge) | The configured bandwidth in bytes, including plan and overage Shown as byte |
cloudsmith.bandwidth_bytes_interval (gauge) | [Deprecated] Bandwidth bytes transferred over the configured bandwidth interval Shown as byte |
cloudsmith.analytics.bytes_downloaded_sum (gauge) | Total bytes downloaded in the configured collection interval Shown as byte |
cloudsmith.analytics.request_count (gauge) | Total download request count in the configured collection interval Shown as item |
cloudsmith.bandwidth.bytes_downloaded (gauge) | Org-wide total bytes downloaded in the configured bandwidth interval Shown as byte |
cloudsmith.bandwidth.request_count (gauge) | Org-wide total download request count in the configured bandwidth interval Shown as item |
Service Checks
cloudsmith.storage
Returns CRITICAL if usage is over 85%, WARNING if usage is over 75%, otherwise returns OK.
Statuses: ok, warning, critical, unknown
cloudsmith.bandwidth
Returns CRITICAL if usage is over 85%, WARNING if usage is over 75%, otherwise returns OK
Statuses: ok, warning, critical, unknown
cloudsmith.can_connect
Returns CRITICAL if the Agent cannot connect to Cloudsmith to collect metrics, otherwise returns OK
Statuses: ok, critical
Events
All Cloudsmith-related events collected appear within the Datadog Event Explorer with the source:cloudsmith tag. Events are collected every five minutes to reduce the number of requests sent to the Cloudsmith API.
There are several types of events available:
- Audit Logs event
- Security Scan event
- Vulnerability Policy Violation event
- License Policy Violation event
- Organization Members summary
- Quota (Raw Usage) Summary
Support
Need help? Contact Cloudsmith support.