Datadog
The Datadog Cloudsmith Integration is a simple and effective visualization tool for monitoring your token, storage, bandwidth usage, audit logs, and vulnerability scanning.
Datadog is an observability service for cloud-scale apps that monitors servers, databases, tools, and services through a SaaS-based data analytics platform. At Cloudsmith, we are big fans of Datadog and use it to monitor and visualize our system's performance across various services and tools.
The Datadog Cloudsmith Integration is a simple and effective visualization tool for your workspace artifact usage, package delivery, audit logs, and your assets' security and compliance details. This integration also helps you monitor consumption and usage within Cloudsmith, along with all of the audit logs and security scanning information we provide to help you spot if any suspicious activity is going on in your workspace.
Metrics Available
The Datadog Cloudsmith integration tracks the following metrics, organized in four main areas:
- Artifact data and package delivery
- Token Visibility
- Workspace members
- Events and Security
Below, you can find more information about each of them.
Artifact data and package delivery
Monitor percentage usage and raw values (in bytes or gigabytes) for both artifact data (storage) and package delivery (bandwidth). Based on your plan limits, usage equal to 75% and 85% triggers critical alerts.
| Metric Name | Metric Type | Description |
|---|---|---|
cloudsmith.storage_used | percent | The percentage of artifact data allowance used. |
cloudsmith.storage_used_bytes | byte | The amount of storage used in bytes. |
cloudsmith.storage_used_gb | byte | The storage used in gigabytes. |
cloudsmith.storage_plan_limit_bytes | byte | The storage limit in bytes defined by the plan. |
cloudsmith.storage_plan_limit_gb | byte | The storage limit in gigabytes defined by the plan. |
cloudsmith.bandwidth_used | percent | The percentage of package delivery allowance used. |
cloudsmith.bandwidth_used_bytes | byte | The amount of bandwidth used in bytes. |
cloudsmith.bandwidth_used_gb | byte | The bandwidth used in gigabytes. |
cloudsmith.bandwidth_plan_limit_bytes | byte | The bandwidth limit in bytes defined by the plan. |
cloudsmith.bandwidth_plan_limit_gb | byte | The bandwidth limit in gigabytes defined by the plan. |
Token visibility
Track the number of entitlement tokens, total downloads, and bandwidth consumed.
| Metric Name | Metric Type | Description |
|---|---|---|
cloudsmith.token_count | item | The number of tokens in an workspace. |
cloudsmith.token_bandwidth_total | byte | The total package delivery (bandwidth) consumed by tokens. |
cloudsmith.token_download_total | item | The total downloads consumed by tokens. |
Workspace members activity & security
Monitor active users, login methods (SAML or password), and 2FA status. Track members by their role breakdown (Owner, Manager, Admin, ReadOnly).
| Metric Name | Metric Type | Description |
|---|---|---|
cloudsmith.cloudsmith.license_policy_violation.count | item | The number of license policy violations. |
cloudsmith.cloudsmith.vulnerability_policy_violation.count | item | The number of vulnerability policy violations. |
cloudsmith.cloudsmith.member.count | item | The number of active members in the workspace. |
cloudsmith.cloudsmith.member.has_2fa.count | item | The number of members with 2FA enabled. |
cloudsmith.cloudsmith.member.saml.count | item | The number of members who logged in with SAML. |
cloudsmith.cloudsmith.member.password.count | item | The number of members who logged in with password. |
cloudsmith.cloudsmith.member.owner.count | item | The number of members with role Owner. |
cloudsmith.cloudsmith.member.manager.count | item | The number of members with role Manager. |
cloudsmith.cloudsmith.member.readonly.count | item | The number of members with role ReadOnly. |
cloudsmith.cloudsmith.member.admin.count | item | The number of members with role Admin. |
cloudsmith.cloudsmith.member.active | item | Whether a Cloudsmith user is active (1 or 0). |
Events & Security Insights
These events offer auditability and policy enforcement tracking.
| Metric Name | Metric Type | Description |
|---|---|---|
cloudsmith.audit_log | event | Captures workspace-wide audit log entries (for example: token creation, user changes, repo settings). |
cloudsmith.vulnerabilities | event | Represents security scan results for packages flagged with known vulnerabilities. |
cloudsmith.vulnerability_policy_violation | event | Indicates violations of vulnerability policies. |
cloudsmith.license_policy_violation | event | Indicates violations of license compliance policies. |
cloudsmith.org_member_summary | event | Summarizes all active members in the workspace including role, 2FA status, and last login method. |
cloudsmith.quota_summary | event | Summarizes quota usage (storage & bandwidth) in both percentage and GB with threshold status |
Install the Cloudsmith Datadog Integration
The Cloudsmith Datadog Integration is a Datadog Community Integration. Follow these steps to install and configure it.
Requirements: Datadog Agent
First things first, you need to install the Datadog Agent.
The Datadog agent is software that runs on your hosts. It collects events and metrics from hosts and sends them to Datadog, where you can analyze your monitoring and performance data. To install the Datadog agent, follow the steps here.
Cloudsmith Datadog Integration Installation
The Cloudsmith check is a Community Integration and isn't included in the Datadog Agent package, so you need to install it.
For Agent versions v7.21+ / v6.21+, follow the instructions below to install the Cloudsmith check on your host. Run the following command to install the Cloudsmith Agent integration:
datadog-agent integration install -t datadog-cloudsmith==1.0.0
Datadog integration docs
📘 Visit the Datadog integration page to find the latest version
Configuration
Once installed, configure your integration similar to core integrations. There are 3 configuration values:
| Config Name | Config Description |
|---|---|
url | The Cloudsmith API URL (https://api.cloudsmith.io/v1) |
cloudsmith_api_key | Your Cloudsmith API key |
organization | The Cloudsmith Workspace (Organization) that you are monitoring |
Follow these steps to configure your Cloudsmith Datadog Integration:
- Edit the
cloudsmith.d/conf.yamlfile, in theconf.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. - Restart the Agent.
Validation
Run the Agent's status subcommand and look for cloudsmith under the Checks section.
Activate the Cloudsmith Integration in Datadog
Log into Datadog and from the side bar select Integrations->integrations and select the Cloudsmith integration.
Open the Configuration tab and select Install Integration.
After these steps, you are ready to start using this integration.
Visualizing your Cloudsmith data in Datadog
Datadog dashboards enable you to efficiently monitor your infrastructure and integrations by displaying and tracking key metrics. Once the Agent is installed with the Cloudsmith check, you can use the metrics in any Datadog dashboard.
The Cloudsmith Datadog Integration comes with its own dashboard allowing you to monitor your Cloudsmith workspaces out of the box.
- From Datadog, select Dashboards->Dashboard list to view your dashboards.
- Select your installed Cloudsmith dashboard, listed as Cloudsmith Overview.
Once completed, you can created a custom Dashboard or just use the default dashboard as displayed in the image below.
Real-time data
Each widget in the dashboard reflects real-time data from the Cloudsmith API and is grouped by functional area — ensuring clear operational visibility for your teams.
To sum it up
The Datadog Cloudsmith Integration is a simple and effective visualization tool for monitoring your token, artifact data, package delivery, audit logs, and vulnerability scanning. Manage and forecast your monthly usage. If you identify a limit that's approaching a threshold, then you can quickly and easily adjust your limits at any time within the Cloudsmith UI.
If you already use Datadog to monitor your tools and services, this tool is for you.
Updated 5 days ago