View as Markdown

ChartMetadata¶

Field	Type	Description
title	string	The title of the chart to be displayed.
summary	optional bitdrift.public.unary.charts.v1.ChartMetadata.Summary	An optional piece of summary information to display alongside the chart.
no_data_message	optional string	An optional message to display when there is no data available for the chart. If not set use the default message.
metric_chart_metadata	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata	Metadata for metric-based charts such as time series, tables, and histograms. (Only one of metric_chart_metadata, or funnel_chart_metadata, flush_chart_metadata, sankey_chart_metadata can be set)
funnel_chart_metadata	bitdrift.public.unary.charts.v1.ChartMetadata.FunnelChartMetadata	Metadata for funnel charts. (Only one of funnel_chart_metadata, or metric_chart_metadata, flush_chart_metadata, sankey_chart_metadata can be set)
flush_chart_metadata	bitdrift.public.unary.charts.v1.ChartMetadata.FlushChartMetadata	Metadata for session capture flush charts. (Only one of flush_chart_metadata, or metric_chart_metadata, funnel_chart_metadata, sankey_chart_metadata can be set)
sankey_chart_metadata	bitdrift.public.unary.charts.v1.ChartMetadata.SankeyChartMetadata	Metadata for sankey charts. (Only one of sankey_chart_metadata, or metric_chart_metadata, funnel_chart_metadata, flush_chart_metadata can be set)

Example¶

JSON

{
  "metric_chart_metadata": {
    "metadata": [
      {
        "connector_export_config": [
          {
            "cloudwatch_connector_export_config": {
              "fixed_dimensions": {
                "key": ""
              },
              "namespace": "payments"
            },
            "connector_name": "primary-cloudwatch"
          }
        ],
        "limit_strategy": {},
        "sort_order": "DESC",
        "title": "My Workflow",
        "top_k_algorithm": "MAX",
        "y_axis": {
          "description": "Example text",
          "unit": "COUNT"
        }
      }
    ],
    "time_series_display_mode": {}
  },
  "no_data_message": "Example text",
  "summary": {
    "description": "Example text"
  },
  "title": "My Workflow"
}

ChartMetadata.FlushChartMetadata¶

No fields

ChartMetadata.SankeyChartMetadata¶

No fields

ChartMetadata.MetricChartMetadata¶

Field	Type	Description
time_series_display_mode	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesDisplayMode	Displays the chart as a time series visualization. (Only one of time_series_display_mode, or table_display_mode, histogram_bar_chart_display_mode can be set)
table_display_mode	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TableDisplayMode	Displays the chart as a table. (Only one of table_display_mode, or time_series_display_mode, histogram_bar_chart_display_mode can be set)
histogram_bar_chart_display_mode	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.HistogramBarChartDisplayMode	Displays histogram data as a bar chart. (Only one of histogram_bar_chart_display_mode, or time_series_display_mode, table_display_mode can be set)
metadata	repeated bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata	Metadata for each time series in the chart. The length of this list should match the number of time series in the chart's query. If a time series does not have metadata, provide the default object and defaults will be used.

Example¶

JSON

{
  "metadata": [
    {
      "connector_export_config": [
        {
          "cloudwatch_connector_export_config": {
            "fixed_dimensions": {
              "key": ""
            },
            "namespace": "payments"
          },
          "connector_name": "primary-cloudwatch"
        }
      ],
      "limit_strategy": {},
      "sort_order": "DESC",
      "title": "My Workflow",
      "top_k_algorithm": "MAX",
      "y_axis": {
        "description": "Example text",
        "unit": "COUNT"
      }
    }
  ],
  "time_series_display_mode": {}
}

ChartMetadata.MetricChartMetadata.TimeSeriesMetadata¶

Field	Type	Description
y_axis	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis	The Y axis of the time series. This is used to format the Y axis of the chart as well as the hover tooltip.
title	string	The title of the time series. This is used to display the time series in the chart.
sort_order	bitdrift.public.unary.charts.v1.SortOrder	Determines how the TopK is sorted when performing TopK queries. Defaults to Maximum.
limit_strategy	optional bitdrift.public.unary.charts.v1.LimitStrategy	Optional limit strategy to persist for this time series (top K count, dimension selection, sort order).
top_k_algorithm	optional bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.TopKAlgorithm	Optional top K algorithm variant to use for this time series.
connector_export_config	repeated bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig	Configuration for exporting data to a connector.

Example¶

JSON

{
  "connector_export_config": [
    {
      "cloudwatch_connector_export_config": {
        "fixed_dimensions": {
          "key": ""
        },
        "namespace": "payments"
      },
      "connector_name": "primary-cloudwatch"
    }
  ],
  "limit_strategy": {},
  "sort_order": "DESC",
  "title": "My Workflow",
  "top_k_algorithm": "MAX",
  "y_axis": {
    "description": "Example text",
    "unit": "COUNT"
  }
}

ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis¶

Field	Type	Description
description	string	The description of the axis to display.
unit	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis.Unit	The unit of the axis.

Example¶

JSON

{
  "description": "Example text",
  "unit": "COUNT"
}

ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis.Unit¶

Name	Number	Description
UNSPECIFIED	0
PERCENTAGE	1
MILLISECONDS	2
TIMESTAMP	3
BYTES	4
COUNT	5
KILOBYTES	6
MEGABYTES	8
SECONDS	9
MINUTES	10
HOURS	11
DAYS	12
GIGABYTES	13

ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig¶

Configuration for exporting data to a connector.

Field	Type	Description
connector_name	string	The name of the connector to which data will be exported. The connector should have already been added via the AdminService's UpsertConnector method. The connector type must match the type expected by the time series export configuration.
cloudwatch_connector_export_config	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig.CloudwatchConnectorExportConfig	Configuration specific to Cloudwatch connectors. Cloudwatch export is only valid for time series that are backed by counters. The configuration will fail if the time series uses histogram data. For metrics that have a numerator and denominator, the export configuration will actually export 2 cloudwatch metrics: one for the numerator and one for the denominator. The user is responsible for interpreting these two metrics correctly. If a numerator and denominator are exported, the supplied namespace will be appended with "/numerator" and "/denominator" for the respective metrics.

Example¶

JSON

{
  "cloudwatch_connector_export_config": {
    "fixed_dimensions": {
      "key": ""
    },
    "namespace": "payments"
  },
  "connector_name": "primary-cloudwatch"
}

ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig.CloudwatchConnectorExportConfig¶

Field	Type	Description
namespace	string	The Cloudwatch namespace to which data will be exported. This will be appended to 'bitdrift/'.
fixed_dimensions	repeated bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig.CloudwatchConnectorExportConfig.FixedDimensionsEntry	A set of fixed dimensions to include with every metric emitted to Cloudwatch. These dimensions will be added in addition to any dimensions specified by the time series query.

Example¶

JSON

{
  "fixed_dimensions": {
    "key": ""
  },
  "namespace": "payments"
}

ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig.CloudwatchConnectorExportConfig.FixedDimensionsEntry¶

No fields

ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.TopKAlgorithm¶

Name	Number	Description
TOP_K_ALGORITHM_UNSPECIFIED	0
TOP_K_ALGORITHM_AVERAGED	1
TOP_K_ALGORITHM_2TIERED	2
TOP_K_ALGORITHM_3TIERED	3

ChartMetadata.MetricChartMetadata.TimeSeriesDisplayMode¶

No fields

ChartMetadata.MetricChartMetadata.TableDisplayMode¶

No fields

ChartMetadata.MetricChartMetadata.HistogramBarChartDisplayMode¶

No fields

ChartMetadata.FunnelChartMetadata¶

Field	Type	Description
steps	repeated bitdrift.public.unary.charts.v1.ChartMetadata.FunnelChartMetadata.StepDetail	Extra details pertaining to each step of the funnel. The step details is associated via the index of the array, e.g. the nth element in this array corresponds to the nth step in the funnel. This allows modifying this data without knowing about the server generated IDs.

Example¶

JSON

{
  "steps": [
    {
      "name": "My Workflow"
    }
  ]
}

ChartMetadata.FunnelChartMetadata.StepDetail¶

Field	Type	Description
name	string	The funnel step name. It is used to display the step in the funnel chart.

Example¶

JSON

{
  "name": "My Workflow"
}

ChartMetadata.Summary¶

Field	Type	Description
description	string	/ A description string that will be displayed alongside the chart as a help text.

Example¶

JSON

{
  "description": "Example text"
}