View as Markdown

ResolvedChart

Source definition: src/bitdrift/public/unary/dashboards/v1/api.proto#L20-L81

Metadata sufficient to render a single chart.

Field	Type	Description
id	bitdrift.public.unary.charts.v1.ChartIdentifier	An opaque identifier object for the chart. This should be provided to the data API in order to fetch/stream the data.
line	bitdrift.public.unary.dashboards.v1.ResolvedChart.Lineonly one of line, or funnel, sankey, table can be set	The chart is a line chart, rendering one or more time series.
funnel	bitdrift.public.unary.dashboards.v1.ResolvedChart.Funnelonly one of funnel, or line, sankey, table can be set	The chart is a funnel chart, rendering the data as a set of steps.
sankey	bitdrift.public.unary.dashboards.v1.ResolvedChart.Sankeyonly one of sankey, or line, funnel, table can be set	The chart is a sankey chart, rendering the data as a set of connected nodes.
table	bitdrift.public.unary.dashboards.v1.ResolvedChart.Tableonly one of table, or line, funnel, sankey can be set	The chart is a table chart, rendering the data as a set of rows and columns.
metadata	bitdrift.public.unary.charts.v1.ChartMetadata	The display metadata for the chart.

Example

JSON

{
  "id": {
    "workflow": {
      "aggregated_action_id": "count/fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
      "chart_rule_id": "_i1yUnHjKfmWpCaD5Tazo",
      "workflow_id": "DFg5"
    }
  },
  "line": {
    "configurable_percentiles": [
      99.0
    ],
    "supports_multiple_percentiles": true
  },
  "metadata": {
    "metric_chart_metadata": {
      "metadata": [
        {
          "connector_export_config": [
            {
              "cloudwatch_connector_export_config": {
                "fixed_dimensions": {
                  "key": ""
                },
                "metric_name": "foreground_launches",
                "namespace": "mobile_metrics"
              },
              "connector_name": "cloudwatch-primary"
            }
          ],
          "limit_strategy": {},
          "sort_order": "DESC",
          "title": "Time series title",
          "top_k_algorithm": "MAX",
          "y_axis": {
            "description": "Count",
            "unit": "COUNT"
          }
        }
      ],
      "time_series_display_mode": {}
    },
    "no_data_message": "Example text",
    "summary": {
      "description": "Example text"
    },
    "title": "Chart title"
  }
}

ResolvedChart.Line

Source definition: src/bitdrift/public/unary/dashboards/v1/api.proto#L25-L39

Field	Type	Description
configurable_percentiles	array of float	If the line chart contains histograms with a top-K grouping, this provides a best-effort list of suggested percentiles. The chart should default to the 0th element in the list, and callers may override that value via the chart API. If this list is empty, the chart does not have suggested default percentile values, but callers may still choose a percentile via the chart API.
supports_multiple_percentiles	bool	Whether or not the chart supports selecting multiple percentiles at once. This will be false for charts which contain grouped histograms or multiple histograms, and true for charts with a single histogram.

Example

JSON

{
  "configurable_percentiles": [
    99.0
  ],
  "supports_multiple_percentiles": true
}

ResolvedChart.Funnel

Source definition: src/bitdrift/public/unary/dashboards/v1/api.proto#L41-L42

No fields

ResolvedChart.Sankey

Source definition: src/bitdrift/public/unary/dashboards/v1/api.proto#L44-L45

No fields

ResolvedChart.Table

Source definition: src/bitdrift/public/unary/dashboards/v1/api.proto#L47-L61

Field	Type	Description
configurable_percentiles	array of float	If the line chart corresponding to this table contains histograms with a top-K grouping, this provides a best-effort list of suggested percentiles. The chart should default to the 0th element in the list, and callers may override that value via the chart API. If this list is empty, the chart does not have suggested default percentile values, but callers may still choose a percentile via the chart API.
supports_multiple_percentiles	bool	Whether or not the chart supports selecting multiple percentiles at once. This will be false for charts which contain grouped histograms or multiple histograms, and true for charts with a single histogram.

Example

JSON

{
  "configurable_percentiles": [
    99.0
  ],
  "supports_multiple_percentiles": true
}