Official

Premium

CloudZero source integration documentation

This plugin is in preview.

Sync from CloudZero to any destination

Publisher

cloudquery

Latest version

v1.0.5

Type

Source

Platforms

Date Published

Documentation Tables Changelog Destinations

Overview Licenses

Overview #

The CloudQuery CloudZero plugin pulls data out of CloudZero and loads it into any supported CloudQuery destination (e.g. ClickHouse, PostgreSQL, BigQuery, Snowflake, and more).

Authentication #

In order to fetch information from CloudZero, cloudquery needs to be authenticated. An API key is required for authentication.

CloudZero Source Plugin Configuration Reference

Example #

This example syncs from CloudZero to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference.

kind: source
# Common source-plugin configuration
spec:
  name: cloudzero
  path: cloudquery/cloudzero
  version: "v1.0.5"
  tables: ["*"]
  destinations: ["postgresql"]
  spec:
    # required
    api_key: "${CLOUDZERO_TOKEN}"
    # optional
    # concurrency: 10
    # table_options: nil

CloudZero Spec #

This is the (nested) spec used by the CloudZero source plugin.

api_key (string) (required)
An API key for your account. See: https://docs.cloudzero.com/reference/authorization#creating-a-new-api-key.
url (string) (optional) (default: https://api.cloudzero.com)
The CloudZero API URL.
concurrency (integer) (optional) (default: 100)
A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
scheduler (string) (optional) (default: shuffle-queue) The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.
For more information about this, see performance tuning.

table_options (map) (optional)

A set of options to override the defaults for certain tables.

The format of the table_options object is as follows:

table_options:
  <table_name>:
    <key>: <value>

The following tables are supported:

table_options:
  cloudzero_billing_costs:
    start_date: 90 days ago
    end_date: now
    cost_type: ""
    filters: ""
    granularity: ""
    group_by: []

CloudZero Table Options Spec #

cloudzero_billing_costs
- start_date (Time) (optional) (default: 90 days ago)
  Sync billing costs starting on this date.
- end_date (Time) (optional) (default: now)
  Sync billing costs up to this date.
- cost_type (enum) (optional) (default: real_cost)
  The cost type. Allowed values:
  
  billed_cost
  
  discounted_cost
  
  amortized_cost
  
  discounted_amortized_cost
  
  real_cost
  
  on_demand_cost
  
  invoiced_amortized_cost
  
  usage_amount
- granularity (enum) (optional) (default: daily)
  The granularity. Allowed values:
  
  hourly
  
  daily
  
  weekly
  
  monthly
  
  yearly
- filters (string) (optional)
  An encoded JSON mapping of Dimension IDs to values by which to filter the results. The keys are dimension IDs; they may be negated with a '!' prefix.
- group_by ([]string) (optional)
  Dimension ID(s) by which to group the results. This is a multi-value query parameter, pass it more than once to specify multiple values.

Table Options Time Format #

This is a special time format that allows either absolute or relative timestamps.

Absolute timestamps must be RFC3339 formatted. Example: 2025-01-01T12:00:00+00:00. Relative timestamps can take this format:

now
x seconds [ago|from now]
x minutes [ago|from now]
x hours [ago|from now]
x days [ago|from now]

Licenses #

The following tools / packages are used in this plugin:

Name	License
github.com/adrg/xdg	MIT
github.com/apache/arrow-go/v18	Apache-2.0
github.com/apache/arrow/go/v13	Apache-2.0
github.com/apapsch/go-jsonmerge/v2	MIT
github.com/aws/aws-sdk-go-v2	Apache-2.0
github.com/aws/aws-sdk-go-v2/config	Apache-2.0
github.com/aws/aws-sdk-go-v2/credentials	Apache-2.0
github.com/aws/aws-sdk-go-v2/feature/ec2/imds	Apache-2.0
github.com/aws/aws-sdk-go-v2/internal/configsources	Apache-2.0
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2	Apache-2.0
github.com/aws/aws-sdk-go-v2/internal/ini	Apache-2.0
github.com/aws/aws-sdk-go-v2/internal/sync/singleflight	BSD-3-Clause
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding	Apache-2.0
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url	Apache-2.0
github.com/aws/aws-sdk-go-v2/service/licensemanager	Apache-2.0
github.com/aws/aws-sdk-go-v2/service/marketplacemetering	Apache-2.0
github.com/aws/aws-sdk-go-v2/service/sso	Apache-2.0
github.com/aws/aws-sdk-go-v2/service/ssooidc	Apache-2.0
github.com/aws/aws-sdk-go-v2/service/sts	Apache-2.0
github.com/aws/smithy-go	Apache-2.0
github.com/aws/smithy-go/internal/sync/singleflight	BSD-3-Clause
github.com/bahlo/generic-list-go	BSD-3-Clause
github.com/buger/jsonparser	MIT
github.com/cenkalti/backoff/v5	MIT
github.com/cloudquery/cloudquery-api-go	MPL-2.0
github.com/cloudquery/codegen/jsonschema/docs	MPL-2.0
github.com/cloudquery/plugin-pb-go	MPL-2.0
github.com/cloudquery/plugin-sdk/v2/internal/glob	MIT
github.com/cloudquery/plugin-sdk/v2/schema	MIT
github.com/cloudquery/plugin-sdk/v2/types	MPL-2.0
github.com/cloudquery/plugin-sdk/v4	MPL-2.0
github.com/cloudquery/plugin-sdk/v4/glob	MIT
github.com/cloudquery/plugin-sdk/v4/scalar	MIT
github.com/davecgh/go-spew/spew	ISC
github.com/getkin/kin-openapi/openapi3	MIT
github.com/ghodss/yaml	MIT
github.com/go-logr/logr	Apache-2.0
github.com/go-logr/stdr	Apache-2.0
github.com/go-openapi/jsonpointer	Apache-2.0
github.com/go-openapi/swag	Apache-2.0
github.com/goccy/go-json	MIT
github.com/google/flatbuffers/go	Apache-2.0
github.com/google/uuid	BSD-3-Clause
github.com/gorilla/mux	BSD-3-Clause
github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors	Apache-2.0
github.com/grpc-ecosystem/grpc-gateway/v2	BSD-3-Clause
github.com/hashicorp/go-cleanhttp	MPL-2.0
github.com/hashicorp/go-retryablehttp	MPL-2.0
github.com/invopop/jsonschema	MIT
github.com/josharian/intern	MIT
github.com/klauspost/compress	Apache-2.0
github.com/klauspost/compress/internal/snapref	BSD-3-Clause
github.com/klauspost/compress/zstd/internal/xxhash	MIT
github.com/mailru/easyjson	MIT
github.com/mattn/go-colorable	MIT
github.com/mattn/go-isatty	MIT
github.com/mohae/deepcopy	MIT
github.com/oapi-codegen/runtime	Apache-2.0
github.com/oasdiff/yaml	MIT
github.com/oasdiff/yaml3	MIT
github.com/perimeterx/marshmallow	MIT
github.com/pierrec/lz4/v4	BSD-3-Clause
github.com/pmezard/go-difflib/difflib	BSD-3-Clause
github.com/rs/zerolog	MIT
github.com/samber/lo	MIT
github.com/santhosh-tekuri/jsonschema/v6	Apache-2.0
github.com/spf13/cobra	Apache-2.0
github.com/spf13/pflag	BSD-3-Clause
github.com/stretchr/testify	MIT
github.com/thoas/go-funk	MIT
github.com/wk8/go-ordered-map/v2	Apache-2.0
github.com/zeebo/xxh3	BSD-2-Clause
go.opentelemetry.io/auto/sdk	Apache-2.0
go.opentelemetry.io/otel	Apache-2.0
go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp	Apache-2.0
go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp	Apache-2.0
go.opentelemetry.io/otel/exporters/otlp/otlptrace	Apache-2.0
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp	Apache-2.0
go.opentelemetry.io/otel/log	Apache-2.0
go.opentelemetry.io/otel/metric	Apache-2.0
go.opentelemetry.io/otel/sdk	Apache-2.0
go.opentelemetry.io/otel/sdk/log	Apache-2.0
go.opentelemetry.io/otel/sdk/metric	Apache-2.0
go.opentelemetry.io/otel/trace	Apache-2.0
go.opentelemetry.io/proto/otlp	Apache-2.0
golang.org/x/exp	BSD-3-Clause
golang.org/x/net	BSD-3-Clause
golang.org/x/sync	BSD-3-Clause
golang.org/x/sys	BSD-3-Clause
golang.org/x/text	BSD-3-Clause
golang.org/x/xerrors	BSD-3-Clause
google.golang.org/genproto/googleapis/api/httpbody	Apache-2.0
google.golang.org/genproto/googleapis/rpc/status	Apache-2.0
google.golang.org/grpc	Apache-2.0
google.golang.org/protobuf	BSD-3-Clause
gopkg.in/yaml.v2	Apache-2.0
gopkg.in/yaml.v3	MIT

Loading plugin documentation