From 32e989495613e66cf62dcf846b8c52ac09025af1 Mon Sep 17 00:00:00 2001 From: Luigi Taglialatela Date: Fri, 8 Nov 2024 09:43:19 +0100 Subject: [PATCH 1/7] Regenerate docs --- docs/data-sources/action.md | 17 +- docs/data-sources/alert.md | 17 +- docs/data-sources/alerts_scheduler.md | 28 +- docs/data-sources/api_key.md | 7 +- docs/data-sources/archive_logs.md | 7 +- docs/data-sources/archive_metrics.md | 5 - docs/data-sources/dashboard.md | 1165 +++++----- docs/data-sources/data_set.md | 12 +- docs/data-sources/enrichment.md | 12 +- docs/data-sources/events2metric.md | 13 +- docs/data-sources/group.md | 1 + docs/data-sources/hosted_dashboard.md | 21 +- docs/data-sources/integration.md | 7 - .../recording_rules_groups_set.md | 8 +- docs/data-sources/rules_group.md | 7 - docs/data-sources/scope.md | 9 +- docs/data-sources/slo.md | 14 +- docs/data-sources/tco_policies_logs.md | 11 +- docs/data-sources/tco_policies_traces.md | 9 +- docs/data-sources/webhook.md | 47 +- docs/guides/api-keys.md | 266 --- docs/index.md | 98 +- docs/resources/action.md | 28 +- docs/resources/alert.md | 837 ++------ docs/resources/alerts_scheduler.md | 76 +- docs/resources/api_key.md | 15 - docs/resources/archive_logs.md | 6 - docs/resources/archive_metrics.md | 11 +- docs/resources/archive_retentions.md | 19 - docs/resources/custom_role.md | 32 +- docs/resources/dashboard.md | 1887 ++++++----------- docs/resources/dashboards_folder.md | 28 - docs/resources/data_set.md | 39 +- docs/resources/enrichment.md | 55 +- docs/resources/events2metric.md | 113 +- docs/resources/grafana_folder.md | 30 +- docs/resources/group.md | 49 - docs/resources/hosted_dashboard.md | 30 +- docs/resources/integration.md | 20 - docs/resources/recording_rules_groups_set.md | 68 +- docs/resources/rules_group.md | 214 +- docs/resources/scope.md | 17 +- docs/resources/slo.md | 53 +- docs/resources/tco_policies_logs.md | 71 +- docs/resources/tco_policies_traces.md | 69 - docs/resources/team.md | 8 - docs/resources/user.md | 27 +- docs/resources/webhook.md | 73 +- examples/dashboard/main.tf | 16 +- examples/data-sources/.gitkeep | 0 examples/provider/provider.tf | 4 + .../coralogix_action/resource.tf} | 0 52 files changed, 1494 insertions(+), 4182 deletions(-) delete mode 100644 docs/guides/api-keys.md create mode 100644 examples/data-sources/.gitkeep create mode 100644 examples/provider/provider.tf rename examples/{action/main.tf => resources/coralogix_action/resource.tf} (100%) diff --git a/docs/data-sources/action.md b/docs/data-sources/action.md index 7afcea72..859206b9 100644 --- a/docs/data-sources/action.md +++ b/docs/data-sources/action.md @@ -1,25 +1,18 @@ --- - # generated by https://github.com/hashicorp/terraform-plugin-docs - page_title: "coralogix_action Data Source - terraform-provider-coralogix" subcategory: "" -description: "Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/." - +description: |- + Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/. --- # coralogix_action (Data Source) -## Example Usage +Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/. -```hcl -data "coralogix_action" imported_action { - id = coralogix_action.action.id -} -``` - + ## Schema ### Required @@ -36,5 +29,3 @@ data "coralogix_action" imported_action { - `source_type` (String) By selecting the data type, you can make sure that the action will be displayed only in the relevant context. Can be one of ["Log" "DataMap"] - `subsystems` (Set of String) Applies the action for specific subsystems. - `url` (String) URL for the external tool. - - diff --git a/docs/data-sources/alert.md b/docs/data-sources/alert.md index fe3ee244..8cde15b8 100644 --- a/docs/data-sources/alert.md +++ b/docs/data-sources/alert.md @@ -2,20 +2,15 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_alert Data Source - terraform-provider-coralogix" subcategory: "" -description: "Coralogix Alert" +description: |- --- # coralogix_alert (Data Source) -Coralogix alert. More info: https://coralogix.com/docs/alerts-api/ . -## Example Usage -```hcl -data "coralogix_alert" "imported_standard_alert" { - id = coralogix_alert.standard_alert.id -} -``` + + ## Schema @@ -36,7 +31,7 @@ data "coralogix_alert" "imported_standard_alert" { - `payload_filters` (Set of String) A list of log fields out of the log example which will be included with the alert notification. - `ratio` (List of Object) Alert based on the ratio between queries. (see [below for nested schema](#nestedatt--ratio)) - `scheduling` (List of Object) Limit the triggering of this alert to specific time frames. Active always by default. (see [below for nested schema](#nestedatt--scheduling)) -- `severity` (String) Determines the alert's severity. Can be one of ["Info" "Warning" "Critical" "Error"] +- `severity` (String) Determines the alert's severity. Can be one of ["Warning" "Critical" "Error" "Info"] - `standard` (List of Object) Alert based on number of log occurrences. (see [below for nested schema](#nestedatt--standard)) - `time_relative` (List of Object) Alert based on ratio between timeframes. (see [below for nested schema](#nestedatt--time_relative)) - `tracing` (List of Object) Alert based on tracing latency. (see [below for nested schema](#nestedatt--tracing)) @@ -151,7 +146,7 @@ Read-Only: - `time_window` (String) -### Nested Schema for `metric.lucene.condition.time_window` +### Nested Schema for `metric.lucene.condition.manage_undetected_values` Read-Only: @@ -188,7 +183,7 @@ Read-Only: - `time_window` (String) -### Nested Schema for `metric.promql.condition.time_window` +### Nested Schema for `metric.promql.condition.manage_undetected_values` Read-Only: diff --git a/docs/data-sources/alerts_scheduler.md b/docs/data-sources/alerts_scheduler.md index 2b333030..ffce697c 100644 --- a/docs/data-sources/alerts_scheduler.md +++ b/docs/data-sources/alerts_scheduler.md @@ -10,13 +10,7 @@ description: |- Coralogix alerts-scheduler. -## Example Usage -```hcl -data "coralogix_alerts_scheduler" "example" { - id = "id" -} -``` ## Schema @@ -89,7 +83,7 @@ Read-Only: - `time_zone` (String) -### Nested Schema for `schedule.one_time.time_frame.time_zone` +### Nested Schema for `schedule.one_time.time_frame.duration` Read-Only: @@ -117,28 +111,28 @@ Read-Only: - `time_frame` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame)) -### Nested Schema for `schedule.recurring.dynamic.time_frame` +### Nested Schema for `schedule.recurring.dynamic.frequency` Read-Only: -- `daily` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame--daily)) -- `monthly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame--monthly)) -- `weekly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame--weekly)) +- `daily` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--daily)) +- `monthly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--monthly)) +- `weekly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--weekly)) - -### Nested Schema for `schedule.recurring.dynamic.time_frame.daily` + +### Nested Schema for `schedule.recurring.dynamic.frequency.daily` - -### Nested Schema for `schedule.recurring.dynamic.time_frame.monthly` + +### Nested Schema for `schedule.recurring.dynamic.frequency.monthly` Read-Only: - `days` (Set of Number) - -### Nested Schema for `schedule.recurring.dynamic.time_frame.weekly` + +### Nested Schema for `schedule.recurring.dynamic.frequency.weekly` Read-Only: diff --git a/docs/data-sources/api_key.md b/docs/data-sources/api_key.md index 2573a480..88e61cf9 100644 --- a/docs/data-sources/api_key.md +++ b/docs/data-sources/api_key.md @@ -10,13 +10,7 @@ description: |- Coralogix Api keys. -## Example Usage -```hcl -data "coralogix_api_key" "same_key_by_id" { - id = coralogix_api_key.example.id -} -``` ## Schema @@ -40,5 +34,6 @@ data "coralogix_api_key" "same_key_by_id" { Read-Only: +- `organisation_id` (String) - `team_id` (String) - `user_id` (String) diff --git a/docs/data-sources/archive_logs.md b/docs/data-sources/archive_logs.md index 81822508..f12423f1 100644 --- a/docs/data-sources/archive_logs.md +++ b/docs/data-sources/archive_logs.md @@ -8,11 +8,8 @@ description: |- # coralogix_archive_logs (Data Source) -# Example Usage -```hcl -data "coralogix_archive_logs" example { -} -``` + + diff --git a/docs/data-sources/archive_metrics.md b/docs/data-sources/archive_metrics.md index e49e1515..767f34bd 100644 --- a/docs/data-sources/archive_metrics.md +++ b/docs/data-sources/archive_metrics.md @@ -8,12 +8,7 @@ description: |- # coralogix_archive_metrics (Data Source) -# Example Usage -```hcl -data "coralogix_archive_metrics" example { -} -``` diff --git a/docs/data-sources/dashboard.md b/docs/data-sources/dashboard.md index 6db620e5..ef8f4860 100644 --- a/docs/data-sources/dashboard.md +++ b/docs/data-sources/dashboard.md @@ -62,7 +62,7 @@ Read-Only: - `strategy` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy)) -### Nested Schema for `annotations.source.logs.strategy` +### Nested Schema for `annotations.source.logs.label_fields` Read-Only: @@ -88,7 +88,7 @@ Read-Only: - `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--duration--start_timestamp_field)) -### Nested Schema for `annotations.source.logs.strategy.duration.start_timestamp_field` +### Nested Schema for `annotations.source.logs.strategy.duration.duration_field` Read-Only: @@ -132,7 +132,7 @@ Read-Only: - `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--range--start_timestamp_field)) -### Nested Schema for `annotations.source.logs.strategy.range.start_timestamp_field` +### Nested Schema for `annotations.source.logs.strategy.range.end_timestamp_field` Read-Only: @@ -186,7 +186,7 @@ Read-Only: - `strategy` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy)) -### Nested Schema for `annotations.source.spans.strategy` +### Nested Schema for `annotations.source.spans.label_fields` Read-Only: @@ -212,7 +212,7 @@ Read-Only: - `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--duration--start_timestamp_field)) -### Nested Schema for `annotations.source.spans.strategy.duration.start_timestamp_field` +### Nested Schema for `annotations.source.spans.strategy.duration.duration_field` Read-Only: @@ -256,7 +256,7 @@ Read-Only: - `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--range--start_timestamp_field)) -### Nested Schema for `annotations.source.spans.strategy.range.start_timestamp_field` +### Nested Schema for `annotations.source.spans.strategy.range.end_timestamp_field` Read-Only: @@ -314,7 +314,7 @@ Read-Only: - `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--filters--source--logs--operator)) -### Nested Schema for `filters.source.logs.operator` +### Nested Schema for `filters.source.logs.observation_field` Read-Only: @@ -360,7 +360,7 @@ Read-Only: - `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--filters--source--spans--operator)) -### Nested Schema for `filters.source.spans.operator` +### Nested Schema for `filters.source.spans.field` Read-Only: @@ -450,7 +450,7 @@ Read-Only: - `pie_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart)) -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart` +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart` Read-Only: @@ -459,53 +459,53 @@ Read-Only: - `data_mode_type` (String) - `group_name_template` (String) - `max_bars_per_chart` (Number) -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query)) - `scale_type` (String) - `sort_by` (String) The field to sort by. Can be one of unspecified, value, name. -- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--stack_definition)) -- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, seconds, kbytes, mbytes, gbytes, mibytes, gibytes, usd_cents, bytes_iec, euro, microseconds, bytes, kibytes, euro_cents, usd. -- `xaxis` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis)) +- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--stack_definition)) +- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. +- `xaxis` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--xaxis)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query` Read-Only: -- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--data_prime)) -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans)) +- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters)) - `group_names` (List of String) - `query` (String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters` Read-Only: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.logs` Read-Only: - `field` (String) Field in the logs to apply the filter on. -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--spans--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--spans--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--logs--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--logs--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.logs.observation_field` Read-Only: @@ -513,8 +513,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.logs.operator` Read-Only: @@ -523,17 +523,17 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.metrics` Read-Only: - `label` (String) - `metric_name` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--metrics--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.metrics.operator` Read-Only: @@ -542,16 +542,16 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.spans` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--spans--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--spans--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--spans--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--spans--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.spans.field` Read-Only: @@ -559,8 +559,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.spans.operator` Read-Only: @@ -571,31 +571,31 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs` Read-Only: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--filters)) - `group_names` (List of String) -- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--group_names_fields)) +- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--group_names_fields)) - `lucene_query` (String) - `stacked_group_name` (String) -- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--stacked_group_name_field)) +- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--stacked_group_name_field)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.aggregation` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--aggregation--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - `type` (String) The type of the aggregation. Can be one of ["count" "count_distinct" "sum" "avg" "min" "max" "percentile"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.aggregation.type` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.aggregation.observation_field` Read-Only: @@ -604,17 +604,17 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.filters` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--filters--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.filters.observation_field` Read-Only: @@ -622,8 +622,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.filters.operator` Read-Only: @@ -632,8 +632,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.group_names_fields` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.group_names_fields` Read-Only: @@ -641,8 +641,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.stacked_group_name_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.stacked_group_name_field` Read-Only: @@ -651,27 +651,27 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.metrics` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--metrics--filters)) - `group_names` (List of String) - `promql_query` (String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.metrics.filters` Read-Only: - `label` (String) Label associated with the metric. - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--metrics--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.metrics.filters.operator` Read-Only: @@ -681,37 +681,37 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans` Read-Only: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters)) -- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--group_names)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--filters)) +- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--group_names)) - `lucene_query` (String) -- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--stacked_group_name)) +- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--stacked_group_name)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.aggregation` Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.filters` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.filters.field` Read-Only: @@ -719,8 +719,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.filters.operator` Read-Only: @@ -729,8 +729,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.group_names` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.group_names` Read-Only: @@ -738,8 +738,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.spans.stacked_group_name` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.stacked_group_name` Read-Only: @@ -749,8 +749,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.stack_definition` Read-Only: @@ -758,16 +758,16 @@ Read-Only: - `stack_name_template` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.xaxis` Read-Only: -- `time` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--time)) -- `value` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--xaxis--value)) +- `time` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--xaxis--time)) +- `value` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--xaxis--value)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.value` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.xaxis.time` Read-Only: @@ -775,26 +775,26 @@ Read-Only: - `interval` (String) The time interval to use for the x-axis. Valid values are in duration format, for example `1m0s` or `1h0m0s` (currently leading zeros should be added). - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.xaxis.value` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.xaxis.value` -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart` +### Nested Schema for `layout.sections.rows.widgets.definition.data_table` Read-Only: -- `columns` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--columns)) -- `data_mode_type` (String) The data mode type. Can be one of ["archive" "unspecified"]. -- `order_by` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--order_by)) -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query)) +- `columns` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--columns)) +- `data_mode_type` (String) The data mode type. Can be one of ["unspecified" "archive"]. +- `order_by` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--order_by)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query)) - `results_per_page` (Number) The number of results to display per page. - `row_style` (String) The style of the rows. Can be one of ["one_line" "two_line" "condensed" "json"]. - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.columns` Read-Only: @@ -802,8 +802,8 @@ Read-Only: - `width` (Number) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.order_by` Read-Only: @@ -811,44 +811,44 @@ Read-Only: - `order_direction` (String) The order direction. Can be one of ["asc" "desc"]. - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query` Read-Only: -- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--data_prime)) -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans)) +- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters)) - `query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters` Read-Only: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.logs` Read-Only: - `field` (String) Field in the logs to apply the filter on. -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--spans--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--spans--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--logs--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--logs--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.logs.observation_field` Read-Only: @@ -856,8 +856,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.logs.operator` Read-Only: @@ -866,17 +866,17 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.metrics` Read-Only: - `label` (String) - `metric_name` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--metrics--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.metrics.operator` Read-Only: @@ -885,16 +885,16 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.spans` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--spans--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--spans--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--spans--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--spans--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.spans.field` Read-Only: @@ -902,8 +902,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.spans.operator` Read-Only: @@ -914,26 +914,26 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters)) -- `grouping` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--filters)) +- `grouping` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping)) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.filters` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--filters--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.filters.observation_field` Read-Only: @@ -941,8 +941,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.filters.operator` Read-Only: @@ -951,37 +951,37 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping` Read-Only: -- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping--aggregations)) +- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping--aggregations)) - `group_by` (List of String) -- `group_bys` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping--group_bys)) +- `group_bys` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping--group_bys)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping.group_bys` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping.aggregations` Read-Only: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping--group_bys--aggregation)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping--aggregations--aggregation)) - `id` (String) - `is_visible` (Boolean) - `name` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping.group_bys.name` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping.aggregations.aggregation` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping--group_bys--name--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping--aggregations--aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - `type` (String) The type of the aggregation. Can be one of ["count" "count_distinct" "sum" "avg" "min" "max" "percentile"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping.group_bys.name.type` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping.aggregations.aggregation.observation_field` Read-Only: @@ -991,8 +991,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping.group_bys` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping.group_bys` Read-Only: @@ -1002,25 +1002,25 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.metrics` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--metrics--filters)) - `promql_query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.metrics.filters` Read-Only: - `label` (String) Label associated with the metric. - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--metrics--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.metrics.filters.operator` Read-Only: @@ -1030,25 +1030,25 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters)) -- `grouping` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--filters)) +- `grouping` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--grouping)) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.filters` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.filters.field` Read-Only: @@ -1056,8 +1056,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.filters.operator` Read-Only: @@ -1066,37 +1066,37 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.grouping` Read-Only: -- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping--aggregations)) -- `group_by` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping--group_by)) +- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--grouping--aggregations)) +- `group_by` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--grouping--group_by)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping.group_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.grouping.aggregations` Read-Only: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--row_style--spans--grouping--group_by--aggregation)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--grouping--aggregations--aggregation)) - `id` (String) - `is_visible` (Boolean) - `name` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping.group_by.name` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.grouping.aggregations.aggregation` Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.row_style.spans.grouping.group_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.grouping.group_by` Read-Only: @@ -1109,58 +1109,58 @@ Read-Only: -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart` +### Nested Schema for `layout.sections.rows.widgets.definition.gauge` Read-Only: -- `data_mode_type` (String) The data mode type. Can be one of ["archive" "unspecified"]. +- `data_mode_type` (String) The data mode type. Can be one of ["unspecified" "archive"]. - `max` (Number) - `min` (Number) -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query)) - `show_inner_arc` (Boolean) - `show_outer_arc` (Boolean) - `threshold_by` (String) The threshold by. Can be one of ["unspecified" "value" "background"]. -- `thresholds` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--thresholds)) -- `unit` (String) The unit of the gauge. Can be one of ["none" "kbytes" "mibytes" "bytes" "kibytes" "euro" "usd_cents" "usd" "microseconds" "milliseconds" "seconds" "euro_cents" "percent" "mbytes" "bytes_iec" "gbytes" "gibytes"]. +- `thresholds` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--thresholds)) +- `unit` (String) The unit of the gauge. Can be one of ["percent" "gbytes" "bytes_iec" "kibytes" "gibytes" "none" "kbytes" "mibytes" "euro" "usd_cents" "seconds" "mbytes" "euro_cents" "usd" "microseconds" "bytes" "milliseconds"]. - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query` Read-Only: -- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--data_prime)) -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans)) +- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters)) - `query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters` Read-Only: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.logs` Read-Only: - `field` (String) Field in the logs to apply the filter on. -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--logs--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--logs--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.logs.observation_field` Read-Only: @@ -1168,8 +1168,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.logs.operator` Read-Only: @@ -1178,17 +1178,17 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.metrics` Read-Only: - `label` (String) - `metric_name` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--metrics--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.metrics.operator` Read-Only: @@ -1197,16 +1197,16 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.spans` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--spans--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--spans--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.spans.field` Read-Only: @@ -1214,8 +1214,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.spans.operator` Read-Only: @@ -1226,26 +1226,26 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters)) -- `logs_aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--logs_aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--filters)) +- `logs_aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--logs_aggregation)) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.filters` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--filters--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.filters.observation_field` Read-Only: @@ -1253,8 +1253,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.filters.operator` Read-Only: @@ -1263,18 +1263,18 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.logs_aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.logs_aggregation` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--logs_aggregation--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--logs_aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - `type` (String) The type of the aggregation. Can be one of ["count" "count_distinct" "sum" "avg" "min" "max" "percentile"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.logs_aggregation.type` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.logs_aggregation.observation_field` Read-Only: @@ -1284,26 +1284,26 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.metrics` Read-Only: -- `aggregation` (String) The type of aggregation. Can be one of ["max" "avg" "sum" "unspecified" "last" "min"]. -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters)) +- `aggregation` (String) The type of aggregation. Can be one of ["unspecified" "last" "min" "max" "avg" "sum"]. +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--metrics--filters)) - `promql_query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.metrics.filters` Read-Only: - `label` (String) Label associated with the metric. - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--metrics--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.metrics.filters.operator` Read-Only: @@ -1313,25 +1313,25 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans--filters)) - `lucene_query` (String) -- `spans_aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--spans_aggregation)) +- `spans_aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans--spans_aggregation)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans.filters` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans.filters.field` Read-Only: @@ -1339,8 +1339,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans.filters.operator` Read-Only: @@ -1349,20 +1349,20 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.spans_aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans.spans_aggregation` Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.thresholds` Read-Only: @@ -1372,7 +1372,7 @@ Read-Only: -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart` +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart` Read-Only: @@ -1382,47 +1382,47 @@ Read-Only: - `display_on_bar` (Boolean) - `group_name_template` (String) - `max_bars_per_chart` (Number) -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query)) - `scale_type` (String) - `sort_by` (String) -- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--stack_definition)) -- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, seconds, kbytes, mbytes, gbytes, mibytes, gibytes, usd_cents, bytes_iec, euro, microseconds, bytes, kibytes, euro_cents, usd. +- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--stack_definition)) +- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. - `y_axis_view_by` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query` Read-Only: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs` Read-Only: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--filters)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--filters)) - `group_names` (List of String) -- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--group_names_fields)) +- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--group_names_fields)) - `lucene_query` (String) - `stacked_group_name` (String) -- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--stacked_group_name_field)) +- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--stacked_group_name_field)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.aggregation` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--aggregation--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - `type` (String) The type of the aggregation. Can be one of ["count" "count_distinct" "sum" "avg" "min" "max" "percentile"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.aggregation.type` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.aggregation.observation_field` Read-Only: @@ -1431,17 +1431,17 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.filters` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--filters--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--filters--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--filters--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.filters.observation_field` Read-Only: @@ -1449,8 +1449,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.filters.operator` Read-Only: @@ -1459,8 +1459,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.group_names_fields` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.group_names_fields` Read-Only: @@ -1468,8 +1468,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.stacked_group_name_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.stacked_group_name_field` Read-Only: @@ -1478,27 +1478,27 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.metrics` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--metrics--filters)) - `group_names` (List of String) - `promql_query` (String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.metrics.filters` Read-Only: - `label` (String) Label associated with the metric. - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--metrics--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.metrics.filters.operator` Read-Only: @@ -1508,37 +1508,37 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans` Read-Only: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--filters)) -- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--group_names)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--filters)) +- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--group_names)) - `lucene_query` (String) -- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--stacked_group_name)) +- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--stacked_group_name)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.aggregation` Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.filters` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--y_axis_view_by--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.filters.field` Read-Only: @@ -1546,8 +1546,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.filters.operator` Read-Only: @@ -1556,8 +1556,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.group_names` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.group_names` Read-Only: @@ -1565,8 +1565,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by.spans.stacked_group_name` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.stacked_group_name` Read-Only: @@ -1576,8 +1576,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.y_axis_view_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.stack_definition` Read-Only: @@ -1587,26 +1587,27 @@ Read-Only: -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart` +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart` Read-Only: -- `legend` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--legend)) -- `query_definitions` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query_definitions)) -- `tooltip` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip)) +- `legend` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--legend)) +- `query_definitions` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions)) +- `tooltip` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--tooltip)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.legend` Read-Only: -- `columns` (List of String) The columns to display in the legend. Valid values are: unspecified, min, max, sum, avg, last. +- `columns` (List of String) The columns to display in the legend. Valid values are: last, unspecified, min, max, sum, avg. - `group_by_query` (Boolean) - `is_visible` (Boolean) Whether to display the legend. False by default. +- `placement` (String) The placement of the legend. Valid values are: hidden, unspecified, auto, bottom, side. - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions` Read-Only: @@ -1615,44 +1616,44 @@ Read-Only: - `id` (String) - `is_visible` (Boolean) - `name` (String) -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--query)) -- `resolution` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--resolution)) -- `scale_type` (String) The scale type. Valid values are: linear, logarithmic, unspecified. +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query)) +- `resolution` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--resolution)) +- `scale_type` (String) The scale type. Valid values are: unspecified, linear, logarithmic. - `series_count_limit` (Number) - `series_name_template` (String) -- `unit` (String) The unit. Valid values are: unspecified, milliseconds, seconds, kbytes, mbytes, gbytes, mibytes, gibytes, usd_cents, bytes_iec, euro, microseconds, bytes, kibytes, euro_cents, usd. +- `unit` (String) The unit. Valid values are: unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query` Read-Only: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.logs` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs` Read-Only: -- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--logs--aggregations)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--logs--filters)) +- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--aggregations)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--filters)) - `group_by` (List of String) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.logs.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.aggregations` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--logs--lucene_query--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--aggregations--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - `type` (String) The type of the aggregation. Can be one of ["count" "count_distinct" "sum" "avg" "min" "max" "percentile"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.logs.lucene_query.type` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.aggregations.observation_field` Read-Only: @@ -1661,17 +1662,17 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.logs.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.filters` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--logs--lucene_query--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--logs--lucene_query--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--filters--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.logs.lucene_query.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.filters.observation_field` Read-Only: @@ -1679,8 +1680,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.logs.lucene_query.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.filters.operator` Read-Only: @@ -1690,25 +1691,25 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.metrics` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.metrics` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--metrics--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--metrics--filters)) - `promql_query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.metrics.promql_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.metrics.filters` Read-Only: - `label` (String) Label associated with the metric. - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--metrics--promql_query--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--metrics--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.metrics.promql_query.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.metrics.filters.operator` Read-Only: @@ -1718,36 +1719,36 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans` Read-Only: -- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--spans--aggregations)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--spans--filters)) -- `group_by` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--spans--group_by)) +- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--aggregations)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--filters)) +- `group_by` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--group_by)) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.spans.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.aggregations` Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.spans.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.filters` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--spans--lucene_query--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--tooltip--unit--spans--lucene_query--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.spans.lucene_query.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.filters.field` Read-Only: @@ -1755,8 +1756,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.spans.lucene_query.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.filters.operator` Read-Only: @@ -1765,8 +1766,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit.spans.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.group_by` Read-Only: @@ -1776,8 +1777,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip.unit` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.resolution` Read-Only: @@ -1786,8 +1787,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.tooltip` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.tooltip` Read-Only: @@ -1797,7 +1798,7 @@ Read-Only: -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart` +### Nested Schema for `layout.sections.rows.widgets.definition.markdown` Read-Only: @@ -1822,7 +1823,7 @@ Read-Only: - `unit` (String) -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit` +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.label_definition` Read-Only: @@ -1834,45 +1835,45 @@ Read-Only: -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit` +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query` Read-Only: -- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--data_prime)) -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans)) +- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters)) - `group_names` (List of String) - `query` (String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters` Read-Only: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--spans)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.logs` Read-Only: - `field` (String) Field in the logs to apply the filter on. -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--logs--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--logs--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.logs.observation_field` Read-Only: @@ -1880,8 +1881,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.logs.operator` Read-Only: @@ -1890,17 +1891,17 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.metrics` Read-Only: - `label` (String) - `metric_name` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--metrics--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.metrics.operator` Read-Only: @@ -1909,16 +1910,16 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.spans` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--spans--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--spans--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--spans--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.spans.field` Read-Only: @@ -1926,8 +1927,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.spans.operator` Read-Only: @@ -1938,31 +1939,31 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs` Read-Only: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--filters)) - `group_names` (List of String) -- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--group_names_fields)) +- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--group_names_fields)) - `lucene_query` (String) - `stacked_group_name` (String) -- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--stacked_group_name_field)) +- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--stacked_group_name_field)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.aggregation` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--aggregation--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - `type` (String) The type of the aggregation. Can be one of ["count" "count_distinct" "sum" "avg" "min" "max" "percentile"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.aggregation.type` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.aggregation.observation_field` Read-Only: @@ -1971,17 +1972,17 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.filters` Read-Only: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--observation_field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--operator)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--filters--observation_field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.filters.observation_field` Read-Only: @@ -1989,8 +1990,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.filters.operator` Read-Only: @@ -1999,8 +2000,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.group_names_fields` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.group_names_fields` Read-Only: @@ -2008,8 +2009,8 @@ Read-Only: - `scope` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.stacked_group_name_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.stacked_group_name_field` Read-Only: @@ -2018,27 +2019,27 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.metrics` Read-Only: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--metrics--filters)) - `group_names` (List of String) - `promql_query` (String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.metrics.filters` Read-Only: - `label` (String) Label associated with the metric. - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--metrics--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.metrics.filters.operator` Read-Only: @@ -2048,37 +2049,37 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans` Read-Only: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters)) -- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--group_names)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--filters)) +- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--group_names)) - `lucene_query` (String) -- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--stacked_group_name)) +- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--stacked_group_name)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.aggregation` Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.filters` Read-Only: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--unit--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.filters.field` Read-Only: @@ -2086,8 +2087,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.filters.operator` Read-Only: @@ -2096,8 +2097,8 @@ Read-Only: - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.group_names` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.group_names` Read-Only: @@ -2105,8 +2106,8 @@ Read-Only: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit.spans.stacked_group_name` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.stacked_group_name` Read-Only: @@ -2117,7 +2118,7 @@ Read-Only: -### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.unit` +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.stack_definition` Read-Only: @@ -2184,18 +2185,18 @@ Read-Only: - `values_order_direction` (String) The order direction of the values. Can be one of `asc`, `desc`. -### Nested Schema for `variables.definition.multi_select.values_order_direction` +### Nested Schema for `variables.definition.multi_select.source` Read-Only: - `constant_list` (List of String) - `logs_path` (String) -- `metric_label` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--metric_label)) -- `query` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query)) -- `span_field` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--span_field)) +- `metric_label` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--metric_label)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query)) +- `span_field` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--span_field)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.metric_label` + +### Nested Schema for `variables.definition.multi_select.source.metric_label` Read-Only: @@ -2203,49 +2204,49 @@ Read-Only: - `metric_name` (String) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query` + +### Nested Schema for `variables.definition.multi_select.source.query` Read-Only: -- `query` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--query)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query)) - `refresh_strategy` (String) -- `value_display_options` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options)) +- `value_display_options` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options` + +### Nested Schema for `variables.definition.multi_select.source.query.query` Read-Only: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--spans)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans` + +### Nested Schema for `variables.definition.multi_select.source.query.query.logs` Read-Only: -- `field_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--field_name)) -- `field_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--field_value)) +- `field_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--logs--field_name)) +- `field_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--logs--field_value)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.field_value` + +### Nested Schema for `variables.definition.multi_select.source.query.query.logs.field_name` Read-Only: - `log_regex` (String) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.field_value` + +### Nested Schema for `variables.definition.multi_select.source.query.query.logs.field_value` Read-Only: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--field_value--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--logs--field_value--observation_field)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.field_value.observation_field` + +### Nested Schema for `variables.definition.multi_select.source.query.query.logs.field_value.observation_field` Read-Only: @@ -2255,43 +2256,43 @@ Read-Only: - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics` Read-Only: -- `label_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--label_name)) -- `label_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--label_value)) -- `metric_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--metric_name)) +- `label_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_name)) +- `label_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value)) +- `metric_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--metric_name)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_name` Read-Only: - `metric_regex` (String) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value` Read-Only: -- `label_filters` (Attributes List) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--metric_name--label_filters)) -- `label_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--metric_name--label_name)) -- `metric_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--metric_name--metric_name)) +- `label_filters` (Attributes List) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters)) +- `label_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_name)) +- `metric_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--metric_name)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name.label_filters` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters` Read-Only: -- `label` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--metric_name--label_filters--label)) -- `metric` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--metric_name--label_filters--metric)) -- `operator` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--metric_name--label_filters--operator)) +- `label` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters--label)) +- `metric` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters--metric)) +- `operator` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters--operator)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name.label_filters.operator` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters.label` Read-Only: @@ -2299,8 +2300,8 @@ Read-Only: - `variable_name` (String) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name.label_filters.operator` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters.metric` Read-Only: @@ -2308,16 +2309,16 @@ Read-Only: - `variable_name` (String) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name.label_filters.operator` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters.operator` Read-Only: -- `selected_values` (Attributes List) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--metric_name--label_filters--operator--selected_values)) +- `selected_values` (Attributes List) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters--operator--selected_values)) - `type` (String) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name.label_filters.operator.type` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters.operator.selected_values` Read-Only: @@ -2327,8 +2328,8 @@ Read-Only: - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name.label_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_name` Read-Only: @@ -2336,8 +2337,8 @@ Read-Only: - `variable_name` (String) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name.metric_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.metric_name` Read-Only: @@ -2346,8 +2347,8 @@ Read-Only: - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.metric_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.metric_name` Read-Only: @@ -2355,24 +2356,24 @@ Read-Only: - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans` + +### Nested Schema for `variables.definition.multi_select.source.query.query.spans` Read-Only: -- `field_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--field_name)) -- `field_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--values_order_direction--query--value_display_options--spans--field_value)) +- `field_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--spans--field_name)) +- `field_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--spans--field_value)) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.field_value` + +### Nested Schema for `variables.definition.multi_select.source.query.query.spans.field_name` Read-Only: - `span_regex` (String) - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options.spans.field_value` + +### Nested Schema for `variables.definition.multi_select.source.query.query.spans.field_value` Read-Only: @@ -2382,8 +2383,8 @@ Read-Only: - -### Nested Schema for `variables.definition.multi_select.values_order_direction.query.value_display_options` + +### Nested Schema for `variables.definition.multi_select.source.query.value_display_options` Read-Only: @@ -2392,8 +2393,8 @@ Read-Only: - -### Nested Schema for `variables.definition.multi_select.values_order_direction.span_field` + +### Nested Schema for `variables.definition.multi_select.source.span_field` Read-Only: diff --git a/docs/data-sources/data_set.md b/docs/data-sources/data_set.md index 8cd3253a..e1102b64 100644 --- a/docs/data-sources/data_set.md +++ b/docs/data-sources/data_set.md @@ -2,21 +2,15 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_data_set Data Source - terraform-provider-coralogix" subcategory: "" -description: "Coralogix data-set. More info: https://coralogix.com/blog/elevate-your-event-data-with-custom-data-enrichment-in-coralogix/." +description: |- --- # coralogix_data_set (Data Source) -Coralogix data-set. More info: https://coralogix.com/blog/elevate-your-event-data-with-custom-data-enrichment-in-coralogix/. -## Example Usage -```hcl -data "coralogix_data_set" "imported_data_set" { - id = coralogix_data_set.data_set.id -} -``` + ## Schema @@ -38,5 +32,3 @@ Read-Only: - `modification_time_uploaded` (String) - `path` (String) - `updated_from_uploading` (Boolean) - - diff --git a/docs/data-sources/enrichment.md b/docs/data-sources/enrichment.md index 7067c985..ab0f4085 100644 --- a/docs/data-sources/enrichment.md +++ b/docs/data-sources/enrichment.md @@ -2,20 +2,14 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_enrichment Data Source - terraform-provider-coralogix" subcategory: "" -description: "Coralogix enrichment. More info: https://coralogix.com/docs/threat-discovery/." +description: |- --- # coralogix_enrichment (Data Source) -Coralogix enrichment. More info: https://coralogix.com/docs/threat-discovery/. -## Example Usage -```hcl -data "coralogix_enrichment" "imported_enrichment" { - id = coralogix_enrichment.geo_ip_enrichment.id -} -``` + @@ -96,5 +90,3 @@ Read-Only: - `id` (Number) - `name` (String) - - diff --git a/docs/data-sources/events2metric.md b/docs/data-sources/events2metric.md index ce41573d..a7ef01b9 100644 --- a/docs/data-sources/events2metric.md +++ b/docs/data-sources/events2metric.md @@ -2,18 +2,13 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_events2metric Data Source - terraform-provider-coralogix" subcategory: "" -description: "Coralogix events2metric. More info:-https://coralogix.com/docs/event2metrics/" +description: |- --- # coralogix_events2metric (Data Source) -## Example Usage -```hcl -data "coralogix_events2metric" "imported_logs2metric" { - id = coralogix_events2metric.logs2metric.id -} -``` + @@ -38,7 +33,7 @@ Read-Only: - `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `lucene` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of severities that we interested in. Can be one of ["Info" "Warning" "Error" "Critical" "Unspecified" "Debug" "Verbose"] +- `severities` (Set of String) An array of severities that we interested in. Can be one of ["Unspecified" "Debug" "Verbose" "Info" "Warning" "Error" "Critical"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx @@ -149,5 +144,3 @@ Read-Only: - `lucene` (String) The search_query that we wanted to be notified on. - `services` (Set of String) An array that contains log’s services names that we want to be notified on. Services can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - - diff --git a/docs/data-sources/group.md b/docs/data-sources/group.md index 1e7cacc5..14b8a347 100644 --- a/docs/data-sources/group.md +++ b/docs/data-sources/group.md @@ -24,3 +24,4 @@ Coralogix group. - `display_name` (String) Group display name. - `members` (Set of String) - `role` (String) +- `scope_id` (String) Scope attached to the group. diff --git a/docs/data-sources/hosted_dashboard.md b/docs/data-sources/hosted_dashboard.md index 177da7fe..371cfe6c 100644 --- a/docs/data-sources/hosted_dashboard.md +++ b/docs/data-sources/hosted_dashboard.md @@ -1,25 +1,18 @@ --- - # generated by https://github.com/hashicorp/terraform-plugin-docs - page_title: "coralogix_hosted_dashboard Data Source - terraform-provider-coralogix" subcategory: "" -description: "Hosted dashboard. Can be one of - ["grafana"]." +description: |- --- # coralogix_hosted_dashboard (Data Source) -## Example Usage -```hcl -data "coralogix_hosted_dashboard" imported_dashboard { - uid = coralogix_hosted_dashboard.dashboard.id -} -``` - + + ## Schema ### Required @@ -29,13 +22,11 @@ data "coralogix_hosted_dashboard" imported_dashboard { ### Read-Only - `grafana` (List of Object) Hosted grafana dashboard. - * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/) - * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/dashboard/) ( - see [below for nested schema](#nestedatt--grafana)) + * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/) + * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/dashboard/) (see [below for nested schema](#nestedatt--grafana)) - `id` (String) The ID of this resource. - ### Nested Schema for `grafana` Read-Only: @@ -48,5 +39,3 @@ Read-Only: - `uid` (String) - `url` (String) - `version` (Number) - - diff --git a/docs/data-sources/integration.md b/docs/data-sources/integration.md index bc9d4c9e..c1676cda 100644 --- a/docs/data-sources/integration.md +++ b/docs/data-sources/integration.md @@ -10,13 +10,6 @@ description: |- A Coralogix Integration -## Example Usage - -```hcl -data "coralogix_integration" "test" { - id = coralogix_integration.test.id -} -``` diff --git a/docs/data-sources/recording_rules_groups_set.md b/docs/data-sources/recording_rules_groups_set.md index bcaf3fec..0eed0254 100644 --- a/docs/data-sources/recording_rules_groups_set.md +++ b/docs/data-sources/recording_rules_groups_set.md @@ -8,13 +8,9 @@ description: |- # coralogix_recording_rules_groups_set (Data Source) -## Example Usage -```hcl -data "coralogix_recording_rules_groups_set" "example_imported" { - id = coralogix_recording_rules_groups_set.example.id -} -``` + + ## Schema diff --git a/docs/data-sources/rules_group.md b/docs/data-sources/rules_group.md index 5a8572ad..ed5f5548 100644 --- a/docs/data-sources/rules_group.md +++ b/docs/data-sources/rules_group.md @@ -7,15 +7,8 @@ description: |- --- # coralogix_rules_group (Data Source) -Rule-group is list of rule-subgroups with 'and' (&&) operation between. More info: https://coralogix.com/docs/rules-api/. -## Example Usage -```hcl -data "coralogix_rules_group" "imported_rules_group_example" { - id = coralogix_rules_group.rules_group_example.id -} -``` diff --git a/docs/data-sources/scope.md b/docs/data-sources/scope.md index 9c123622..b883354a 100644 --- a/docs/data-sources/scope.md +++ b/docs/data-sources/scope.md @@ -11,13 +11,6 @@ description: |- Coralogix Scope. -## Example Usage - -```hcl -data "coralogix_scope" "data_example" { - id = coralogix_scope.example.id -} -``` ## Schema @@ -28,7 +21,7 @@ data "coralogix_scope" "data_example" { ### Read-Only -- `default_expression` (String) Default expression to use when no filter matches the query. Until further notice, this can is limited to `true` (everything is included) or `false` (nothing is included). Use a version tag (e.g ` true` or ` false`) +- `default_expression` (String) Default expression to use when no filter matches the query. Until further notice, this can is limited to `true` (everything is included) or `false` (nothing is included). Use a version tag (e.g `true` or `false`) - `description` (String) Description of the scope. Optional. - `display_name` (String) Scope display name. - `filters` (Attributes List) Filters applied to include data in the scope. (see [below for nested schema](#nestedatt--filters)) diff --git a/docs/data-sources/slo.md b/docs/data-sources/slo.md index a7f894cb..f9988391 100644 --- a/docs/data-sources/slo.md +++ b/docs/data-sources/slo.md @@ -8,16 +8,8 @@ description: |- # coralogix_slo (Data Source) -Use this data source to obtain the necessary fields to set up Coralogix Service Level Objectives (SLOs). -Data about individual SLOs can be retrieved by providing the specific SLO `id`. +Coralogix SLO. -## Example Usage - -```hcl -data "coralogix_slo" "example" { - id = "example-id" -} -``` @@ -38,7 +30,7 @@ data "coralogix_slo" "example" { - `status` (String) - `target_percentage` (Number) Target percentage. This is the target percentage of the SLO. - `threshold_microseconds` (Number) Threshold in microseconds. Required when `type` is `latency`. -- `threshold_symbol_type` (String) Threshold symbol type. Required when `type` is `latency`. Valid values are: ["greater" "greater_or_equal" "less" "less_or_equal" "equal"] +- `threshold_symbol_type` (String) Threshold symbol type. Required when `type` is `latency`. Valid values are: ["greater_or_equal" "less" "less_or_equal" "equal" "greater"] - `type` (String) Type. This is the type of the SLO. Valid values are: "error", "latency". @@ -46,6 +38,6 @@ data "coralogix_slo" "example" { Read-Only: -- `compare_type` (String) Compare type. This is the compare type of the SLO. Valid values are: ["starts_with" "ends_with" "includes" "unspecified" "is"] +- `compare_type` (String) Compare type. This is the compare type of the SLO. Valid values are: ["unspecified" "is" "starts_with" "ends_with" "includes"] - `field` (String) - `field_values` (Set of String) diff --git a/docs/data-sources/tco_policies_logs.md b/docs/data-sources/tco_policies_logs.md index 6b32db7e..735eb398 100644 --- a/docs/data-sources/tco_policies_logs.md +++ b/docs/data-sources/tco_policies_logs.md @@ -10,12 +10,6 @@ description: |- Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. -## Example Usage - -```hcl -data "coralogix_tco_policies_logs" "example" { -} -``` @@ -23,6 +17,7 @@ data "coralogix_tco_policies_logs" "example" { ### Read-Only +- `id` (String) This field can be ignored - `policies` (Attributes List) (see [below for nested schema](#nestedatt--policies)) @@ -38,7 +33,7 @@ Read-Only: - `name` (String) tco-policy name. - `order` (Number) The policy's order between the other policies. - `priority` (String) The policy priority. Can be one of ["block" "high" "low" "medium"]. -- `severities` (Set of String) The severities to apply the policy on. Can be few of ["verbose" "info" "warning" "error" "critical" "debug"]. +- `severities` (Set of String) The severities to apply the policy on. Can be few of ["critical" "debug" "verbose" "info" "warning" "error"]. - `subsystems` (Attributes) The subsystems to apply the policy on. Applies the policy on all the subsystems by default. (see [below for nested schema](#nestedatt--policies--subsystems)) @@ -47,7 +42,7 @@ Read-Only: Read-Only: - `names` (Set of String) -- `rule_type` (String) The rule type. Can be one of ["includes" "is" "is_not" "starts_with"]. +- `rule_type` (String) The rule type. Can be one of ["is" "is_not" "starts_with" "includes"]. diff --git a/docs/data-sources/tco_policies_traces.md b/docs/data-sources/tco_policies_traces.md index c7fb678b..41f649ce 100644 --- a/docs/data-sources/tco_policies_traces.md +++ b/docs/data-sources/tco_policies_traces.md @@ -11,13 +11,6 @@ description: |- Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. -## Example Usage - -```hcl -data "coralogix_tco_policies_traces" "example" { -} -``` - ## Schema @@ -87,4 +80,4 @@ Read-Only: Read-Only: - `names` (Set of String) -- `rule_type` (String) \ No newline at end of file +- `rule_type` (String) diff --git a/docs/data-sources/webhook.md b/docs/data-sources/webhook.md index b6635d74..d9678294 100644 --- a/docs/data-sources/webhook.md +++ b/docs/data-sources/webhook.md @@ -10,46 +10,7 @@ description: |- Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/. -## Example Usage - -```hcl -data "coralogix_webhook" "imported_webhook_by_id" { - id = "60f3b3b3d7b3b00001b3b3b3" -} - -data "coralogix_webhook" "imported_webhook_by_name" { - name = "slack-webhook" -} -``` - -## Example Usage of link webhook to alert. -### **please note that the linkage is done by the external_id (and not by the id)** -```hcl -data "coralogix_webhook" "imported_webhook_by_id" { - name = "slack-webhook" -} - -resource "coralogix_alert" "standard_alert" { - name = "Standard alert example" - description = "Example of standard alert from terraform" - severity = "Critical" - - notifications_group { - notification { - integration_id = data.coralogix_webhook.imported_webhook_by_id.external_id - retriggering_period_minutes = 60 - notify_on = "Triggered_only" - } - } - - standard { - search_query = "remote_addr_enriched:/.*/" - condition { - immediately = true - } - } -} -``` + ## Schema @@ -80,7 +41,7 @@ resource "coralogix_alert" "standard_alert" { Read-Only: - `headers` (Map of String) Webhook headers. Map of string to string. -- `method` (String) Webhook method. can be one of: post, put, get +- `method` (String) Webhook method. can be one of: get, post, put - `payload` (String) Webhook payload. JSON string. - `url` (String) Webhook URL. - `uuid` (String) Webhook UUID. Computed automatically. @@ -175,7 +136,7 @@ Read-Only: Read-Only: - `attachments` (Attributes List) Slack attachments. (see [below for nested schema](#nestedatt--slack--attachments)) -- `notify_on` (Set of String) Slack notifications. can be one of: flow_anomalies, spike_anomalies, data_usage, error_and_critical_logs +- `notify_on` (Set of String) Slack notifications. can be one of: error_and_critical_logs, flow_anomalies, spike_anomalies, data_usage - `url` (String) Slack URL. @@ -184,4 +145,4 @@ Read-Only: Read-Only: - `active` (Boolean) Determines if the attachment is active. Default is true. -- `type` (String) Slack attachment type. can be one of: empty, metric_snapshot, logs +- `type` (String) Slack attachment type. can be one of: logs, empty, metric_snapshot diff --git a/docs/guides/api-keys.md b/docs/guides/api-keys.md deleted file mode 100644 index 65be927d..00000000 --- a/docs/guides/api-keys.md +++ /dev/null @@ -1,266 +0,0 @@ -# Upgrading API Keys (from < 1.16) - -With version 1.16, the API Keys resource has been upgraded to the latest available version of the GRPC API which replaces "roles" with "presets" and "permissions". Read more [https://coralogix.com/docs/api-keys/](). This document is the guide on how you can update your existing Terraform files. - -## Legacy And New API Keys - -The change in the underlying permission model created two types of API keys with the old one being described as "legacy keys". Internally all keys have been transitioned to the new model, however there are two key differences: - -1. Legacy keys are "Custom" keys that have a custom set of permissions, instead of a preset -2. Legacy key permissions cannot be updated - -Therefore legacy keys can remain in use as long as no changes to the associated permissions are required. - -### Mapping Roles to Permissions - -Internally, existing roles are mapped to the following set of custom permissions: - - -| Role | Permissions | -|------------------------|------------------------------------------------------------------------------------------------------------| -| RUM Ingress | - rum-ingress:SendData | -| Send Data | - cloud-metadata-ingress:SendData
- logs.data-ingress:SendData
- metrics.data-ingress:SendData
- spans.data-ingress:SendData | -| Coralogix CLI | - data-usage:Read
- org-quota:Manage
- org-quota:Read
- org-teams:Manage
- org-teams:ReadConfig
- team-members:Manage
- team-members:ReadConfig
- team-scim:Manage
- team-scim:ReadConfig
- team-sso:Manage
- team-sso:ReadConfig
- team-quota:Manage
- team-quota:Read | -| SCIM | - team-groups:Manage
- team-groups:ReadConfig
- team-members:Manage
- team-members:ReadConfig
- team-roles:ReadConfig | -| Role Management | - team-roles:Manage
- team-roles:ReadConfig | -| Trigger Webhook | - contextual-data:SendData | -| Legacy Api Key | - alerts:ReadConfig
- alerts:UpdateConfig
- cloud-metadata-enrichment:ReadConfig
- cloud-metadata-enrichment:UpdateConfig
- data-usage:Read
- geo-enrichment:ReadConfig
- geo-enrichment:UpdateConfig
- grafana:Read
- grafana:Update
- logs.data-setup#low:ReadConfig
- logs.data-setup#low:UpdateConfig
- logs.events2metrics:ReadConfig
- logs.events2metrics:UpdateConfig
- logs.tco:ReadPolicies
- logs.tco:UpdatePolicies
- metrics.data-analytics#high:Read
- metrics.data-analytics#low:Read
- metrics.data-setup#high:ReadConfig
- metrics.data-setup#high:UpdateConfig
- metrics.data-setup#low:ReadConfig
- metrics.data-setup#low:UpdateConfig
- metrics.recording-rules:ReadConfig
- metrics.recording-rules:UpdateConfig
- metrics.tco:ReadPolicies
- metrics.tco:UpdatePolicies
- outbound-webhooks:ReadConfig
- outbound-webhooks:UpdateConfig
- parsing-rules:ReadConfig
- parsing-rules:UpdateConfig
- security-enrichment:ReadConfig
- security-enrichment:UpdateConfig
- serverless:Read
- service-catalog:ReadDimensionsConfig
- service-catalog:ReadSLIConfig
- service-catalog:UpdateDimensionsConfig
- service-catalog:UpdateSLIConfig
- service-map:Read
- source-mapping:UploadMapping
- spans.data-api#high:ReadData
- spans.data-api#low:ReadData
- spans.data-setup#low:ReadConfig
- spans.data-setup#low:UpdateConfig
- spans.events2metrics:ReadConfig
- spans.events2metrics:UpdateConfig
- spans.tco:ReadPolicies
- spans.tco:UpdatePolicies
- team-actions:ReadConfig
- team-actions:UpdateConfig
- team-api-keys-security-settings:Manage
- team-api-keys-security-settings:ReadConfig
- team-api-keys:Manage
- team-api-keys:ReadConfig
- team-custom-enrichment:ReadConfig
- team-custom-enrichment:ReadData
- team-custom-enrichment:UpdateConfig
- team-custom-enrichment:UpdateData
- team-dashboards:Read
- team-dashboards:Update
- user-actions:ReadConfig
- user-actions:UpdateConfig
- user-dashboards:Read
- user-dashboards:Update
- version-benchmark-tags:Read
- logs.alerts:ReadConfig
- logs.alerts:UpdateConfig
- spans.alerts:ReadConfig
- spans.alerts:UpdateConfig
- metrics.alerts:ReadConfig
- metrics.alerts:UpdateConfig
- livetail:Read
- service-catalog:Read
- version-benchmark-tags:Update
- service-catalog:ReadApdexConfig
- service-catalog:UpdateApdexConfig
- service-catalog:Update
- team-quota:Manage
- team-quota:Read | -| Query Data Legacy | - logs.data-api#high:ReadData
- logs.data-api#low:ReadData
- metrics.data-api#high:ReadData
- metrics.data-api#low:ReadData
- opensearch-dashboards:Read
- opensearch-dashboards:Update
- snowbit.cspm:Read
- snowbit.sspm:Read
- spans.data-api#high:ReadData
- spans.data-api#low:ReadData
- livetail:Read | - -If an API key had multiple roles, the permissions are merged. - -## Upgrade Procedure - -The new provider version upgrades the state automatically, however the `.tf` files need to reflect those updates as well - anything else would be considered a change by terraform. Here is a step by step upgrade guide: - -0. Upgrade the provider -1. Run `terraform refresh` -2. Locate the `coralogix_api_key` resources and create a property `permissions` corresponding to the roles in `roles`. Use the table above or examples below. -3. Add a property `presets = []` and remove the `roles` property -4. Run `terraform plan`, there should be no changes to the API keys requested - -## Examples - -**1.15.x:** - -```hcl -resource "coralogix_api_key" "example" { - name = "My SCIM KEY" - owner = { - team_id : "5633574" - } - active = true - roles = ["SCIM", "Legacy Api Key", "Role Management", "Send Data"] -} -``` - -**>1.16:** - -```hcl -resource "coralogix_api_key" "example" { - name = "My SCIM KEY" - owner = { - team_id : "5633574" - } - active = true - permissions = [ - "alerts:ReadConfig", - "alerts:UpdateConfig", - "cloud-metadata-enrichment:ReadConfig", - "cloud-metadata-enrichment:UpdateConfig", - "cloud-metadata-ingress:SendData", - "data-usage:Read", - "geo-enrichment:ReadConfig", - "geo-enrichment:UpdateConfig", - "grafana:Read", - "grafana:Update", - "incidents:Acknowledge", - "incidents:Assign", - "incidents:Close", - "incidents:Read", - "incidents:Snooze", - "livetail:Read", - "logs.alerts:ReadConfig", - "logs.alerts:UpdateConfig", - "logs.data-ingress:SendData", - "logs.data-setup#low:ReadConfig", - "logs.data-setup#low:UpdateConfig", - "logs.events2metrics:ReadConfig", - "logs.events2metrics:UpdateConfig", - "logs.tco:ReadPolicies", - "logs.tco:UpdatePolicies", - "metrics.alerts:ReadConfig", - "metrics.alerts:UpdateConfig", - "metrics.data-analytics#high:Read", - "metrics.data-analytics#low:Read", - "metrics.data-ingress:SendData", - "metrics.data-setup#high:ReadConfig", - "metrics.data-setup#high:UpdateConfig", - "metrics.data-setup#low:ReadConfig", - "metrics.data-setup#low:UpdateConfig", - "metrics.recording-rules:ReadConfig", - "metrics.recording-rules:UpdateConfig", - "metrics.tco:ReadPolicies", - "metrics.tco:UpdatePolicies", - "outbound-webhooks:ReadConfig", - "outbound-webhooks:UpdateConfig", - "parsing-rules:ReadConfig", - "parsing-rules:UpdateConfig", - "security-enrichment:ReadConfig", - "security-enrichment:UpdateConfig", - "serverless:Read", - "service-catalog:Read", - "service-catalog:ReadApdexConfig", - "service-catalog:ReadDimensionsConfig", - "service-catalog:ReadSLIConfig", - "service-catalog:Update", - "service-catalog:UpdateApdexConfig", - "service-catalog:UpdateDimensionsConfig", - "service-catalog:UpdateSLIConfig", - "service-map:Read", - "source-mapping:UploadMapping", - "spans.alerts:ReadConfig", - "spans.alerts:UpdateConfig", - "spans.data-api#high:ReadData", - "spans.data-api#low:ReadData", - "spans.data-ingress:SendData", - "spans.data-setup#low:ReadConfig", - "spans.data-setup#low:UpdateConfig", - "spans.events2metrics:ReadConfig", - "spans.events2metrics:UpdateConfig", - "spans.tco:ReadPolicies", - "spans.tco:UpdatePolicies", - "suppression-rules:ReadConfig", - "suppression-rules:UpdateConfig", - "team-actions:ReadConfig", - "team-actions:UpdateConfig", - "team-api-keys-security-settings:Manage", - "team-api-keys-security-settings:ReadConfig", - "team-api-keys:Manage", - "team-api-keys:ReadConfig", - "team-custom-enrichment:ReadConfig", - "team-custom-enrichment:ReadData", - "team-custom-enrichment:UpdateConfig", - "team-custom-enrichment:UpdateData", - "team-dashboards:Read", - "team-dashboards:Update", - "team-groups:Manage", - "team-groups:ReadConfig", - "team-members:Manage", - "team-members:ReadConfig", - "team-quota:Manage", - "team-quota:Read", - "team-roles:Manage", - "team-roles:ReadConfig", - "user-actions:ReadConfig", - "user-actions:UpdateConfig", - "user-dashboards:Read", - "user-dashboards:Update", - "version-benchmark-tags:Read", - "version-benchmark-tags:Update" - ] - presets = [] -} -``` - ---- - -**1.15.x:** - -```hcl -resource "coralogix_api_key" "example" { - name = "My RUM KEY" - owner = { - team_id : "5633574" - } - active = true - roles = ["RUM Ingress"] -} -``` - -**>1.16:** - -```hcl -resource "coralogix_api_key" "example" { - name = "My RUM KEY" - owner = { - team_id : "5633574" - } - active = true - permissions = [ - "rum-ingress:SendData" - ] - presets = [] -} -``` ---- - -**1.15.x:** - -```hcl -resource "coralogix_api_key" "example" { - name = "My WH KEY" - owner = { - team_id : "5633574" - } - active = true - roles = ["Trigger Webhook"] -} -``` - -**>1.16:** - -```hcl -resource "coralogix_api_key" "example" { - name = "My WH KEY" - owner = { - team_id : "5633574" - } - active = true - permissions = [ - "contextual-data:SendData" - ] - presets = [] -} -``` - ---- - -**1.15.x:** - -```hcl -resource "coralogix_api_key" "example" { - name = "My RBAC KEY" - owner = { - team_id : "5633574" - } - active = true - roles = ["SCIM", "Role Management"] -} -``` - -**>1.16:** - -```hcl -resource "coralogix_api_key" "example" { - name = "My RBAC KEY" - owner = { - team_id : "5633574" - } - active = true - permissions = [ - "team-roles:Manage", - "team-roles:ReadConfig", - "team-groups:Manage", - "team-groups:ReadConfig", - "team-members:Manage", - "team-members:ReadConfig" - ] - presets = [] -} -``` - -## Limitations - -- Encrypted (hashed) keys are unsupported in this provider, therefore all keys are created in plain text - diff --git a/docs/index.md b/docs/index.md index ff008fd8..55939f2b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,98 +1,22 @@ --- -layout: "coralogix" -page_title: "Provider: Coralogix" -description: "The Coralogix provider is used to interact with the resources supported by Coralogix. The provider needs -to be configured with the proper credentials before it can be used." +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "coralogix Provider" +subcategory: "" +description: |- + --- -# Coralogix Provider +# coralogix Provider -The Coralogix provider is used to interact with the resources supported by [Coralogix](https://coralogix.com/). The -provider needs to be configured with the proper credentials before it can be used. -## Example Usage -```hcl -terraform { - required_providers { - coralogix = { - version = "" - source = "coralogix/coralogix" - } - } -} -provider "coralogix" { - api_key = "" - env = "" -} - -resource "coralogix_rules_group" "my_first_rules_group" { - name = "my first rules_group" -} -``` +## Schema -## Authentication -For authentication, the Coralogix provider uses an api-key (under API Keys in the UI - Alerts, Rules and Tags API Key). -The api-key and the desired environment for using the Coralogix provider can be set in two ways: - -1. Explicitly: - -```hcl -provider "coralogix" { - api_key = "" - env = "" -} -``` - -2. Implicitly through environment variables: - -```sh -$ export CORALOGIX_API_KEY="" -``` - -```sh -$ export CORALOGIX_ENV="" -``` - -## Private Domains - -For private domain the `domain` field or the environment variables `CORALOGIX_DOMAIN` have to be defined (instead -of `env` or `CORALOGIX_ENV`). - -```sh -provider "coralogix" { - api_key = "" - domain = "cx.coralogix.com" -} -``` - -OR - -```sh -$ export CORALOGIX_DOMAIN="" -``` - -## region-domain table: - -| Region | Short | Domain | -|---------|-------|---------------------| -| APAC1 | AP1 | coralogix.in | -| APAC2 | AP2 | coralogixsg.com | -| EUROPE1 | EU1 | coralogix.com | -| EUROPE2 | EU2 | eu2.coralogix.com | -| USA1 | US1 | coralogix.us | -| USA2 | US2 | cx498.coralogix.com | - -For more information on the endpoints, check out [https://coralogix.com/docs/coralogix-endpoints/]() - -## Argument Reference +### Optional -- `api_key` (String, Sensitive) A key for using coralogix APIs (Auto Generated), appropriate for the defined - environment. environment variable 'CORALOGIX_API_KEY' can be defined instead. -- `domain` (String) The Coralogix domain. Conflict With 'env'. environment variable 'CORALOGIX_DOMAIN' can be defined - instead. -- `env` (String) The Coralogix API environment. can be one of ["USA1" "USA2" "APAC1" "APAC2" "EUROPE1" "EUROPE2" "US1" "US2" "AP1" "AP2" "EU1" "EU2"]. environment - variable 'CORALOGIX_ENV' can be defined instead. +- `api_key` (String, Sensitive) A key for using coralogix APIs (Auto Generated), appropriate for the defined environment. environment variable 'CORALOGIX_API_KEY' can be defined instead. +- `domain` (String) The Coralogix domain. Conflict With 'env'. environment variable 'CORALOGIX_DOMAIN' can be defined instead. +- `env` (String) The Coralogix API environment. can be one of ["USA1" "USA2" "AP1" "AP2" "EU1" "EUROPE2" "EU2" "APAC1" "APAC2" "EUROPE1" "US1" "US2"]. environment variable 'CORALOGIX_ENV' can be defined instead. diff --git a/docs/resources/action.md b/docs/resources/action.md index 625878da..cda40781 100644 --- a/docs/resources/action.md +++ b/docs/resources/action.md @@ -2,7 +2,8 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_action Resource - terraform-provider-coralogix" subcategory: "" -description: "Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/." +description: |- + Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/. --- # coralogix_action (Resource) @@ -10,16 +11,6 @@ description: "Coralogix action. For more info please review - https://coralogix. Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/. -## Example Usage - -```hcl -resource "coralogix_action" action { - is_private = true - source_type = "Log" - name = "google search action" - url = "https://www.google.com/search?q={{$p.selected_value}}" -} -``` ## Schema @@ -41,18 +32,3 @@ resource "coralogix_action" action { - `created_by` (String) The user who created the action. - `id` (String) Action ID. - - -### Import -```sh -terraform import coralogix_action.example -``` - -to get the action id run the following command and look for the id field of the action you want to import: -```sh -grpcurl -H "Authorization: Bearer " -d @ ng-api-grpc.:443 com.coralogixapis.actions.v2.ActionsService/ListActions < + ## Schema ### Required - `name` (String) Alert name. -- `severity` (String) Determines the alert's severity. Can be one of ["Info" "Warning" "Critical" "Error"] +- `severity` (String) Determines the alert's severity. Can be one of ["Warning" "Critical" "Error" "Info"] ### Optional - `description` (String) Alert description. - `enabled` (Boolean) Determines whether the alert will be active. True by default. -- `expiration_date` (Block List, Max: 1) The expiration date of the alert (if declared). ( - see [below for nested schema](#nestedblock--expiration_date)) -- `flow` (Block List, Max: 1) Alert based on a combination of alerts in a specific timeframe. ( - see [below for nested schema](#nestedblock--flow)) +- `expiration_date` (Block List, Max: 1) The expiration date of the alert (if declared). (see [below for nested schema](#nestedblock--expiration_date)) +- `flow` (Block List, Max: 1) Alert based on a combination of alerts in a specific timeframe. (see [below for nested schema](#nestedblock--flow)) - `incident_settings` (Block List, Max: 1) (see [below for nested schema](#nestedblock--incident_settings)) -- `meta_labels` (Map of String) Labels allow you to easily filter by alert type and create views. Insert a new label or - use an existing one. You can nest a label using key:value. -- `metric` (Block List, Max: 1) Alert based on arithmetic operators for metrics. ( - see [below for nested schema](#nestedblock--metric)) -- `new_value` (Block List, Max: 1) Alert on never before seen log value. ( - see [below for nested schema](#nestedblock--new_value)) -- `notifications_group` (Block Set) Defines notifications settings over list of group-by keys (or on empty list). ( - see [below for nested schema](#nestedblock--notifications_group)) -- `payload_filters` (Set of String) A list of log fields out of the log example which will be included with the alert - notification. -- `ratio` (Block List, Max: 1) Alert based on the ratio between queries. ( - see [below for nested schema](#nestedblock--ratio)) -- `scheduling` (Block List, Max: 1) Limit the triggering of this alert to specific time frames. Active always by - default. (see [below for nested schema](#nestedblock--scheduling)) -- `standard` (Block List, Max: 1) Alert based on number of log occurrences. ( - see [below for nested schema](#nestedblock--standard)) -- `time_relative` (Block List, Max: 1) Alert based on ratio between timeframes. ( - see [below for nested schema](#nestedblock--time_relative)) +- `meta_labels` (Map of String) Labels allow you to easily filter by alert type and create views. Insert a new label or use an existing one. You can nest a label using key:value. +- `metric` (Block List, Max: 1) Alert based on arithmetic operators for metrics. (see [below for nested schema](#nestedblock--metric)) +- `new_value` (Block List, Max: 1) Alert on never before seen log value. (see [below for nested schema](#nestedblock--new_value)) +- `notifications_group` (Block Set) Defines notifications settings over list of group-by keys (or on empty list). (see [below for nested schema](#nestedblock--notifications_group)) +- `payload_filters` (Set of String) A list of log fields out of the log example which will be included with the alert notification. +- `ratio` (Block List, Max: 1) Alert based on the ratio between queries. (see [below for nested schema](#nestedblock--ratio)) +- `scheduling` (Block List, Max: 1) Limit the triggering of this alert to specific time frames. Active always by default. (see [below for nested schema](#nestedblock--scheduling)) +- `standard` (Block List, Max: 1) Alert based on number of log occurrences. (see [below for nested schema](#nestedblock--standard)) +- `time_relative` (Block List, Max: 1) Alert based on ratio between timeframes. (see [below for nested schema](#nestedblock--time_relative)) - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) - `tracing` (Block List, Max: 1) Alert based on tracing latency. (see [below for nested schema](#nestedblock--tracing)) -- `unique_count` (Block List, Max: 1) Alert based on unique value count per key. ( - see [below for nested schema](#nestedblock--unique_count)) +- `unique_count` (Block List, Max: 1) Alert based on unique value count per key. (see [below for nested schema](#nestedblock--unique_count)) ### Read-Only - `id` (String) The ID of this resource. - ### Nested Schema for `expiration_date` Required: @@ -541,8 +53,8 @@ Required: - `month` (Number) Month of a year. Must be from 1 to 12. - `year` (Number) Year of the date. Must be from 1 to 9999. - + ### Nested Schema for `flow` Required: @@ -554,7 +66,6 @@ Optional: - `group_by` (List of String) - ### Nested Schema for `flow.stage` Required: @@ -563,31 +74,25 @@ Required: Optional: -- `time_window` (Block List, Max: 1) Timeframe for flow stage. ( - see [below for nested schema](#nestedblock--flow--stage--time_window)) +- `time_window` (Block List, Max: 1) Timeframe for flow stage. (see [below for nested schema](#nestedblock--flow--stage--time_window)) - ### Nested Schema for `flow.stage.group` Required: - `next_operator` (String) The operator to use on the alert. can be one of ["AND" "OR"] -- `sub_alerts` (Block List, Min: 1, Max: 1) ( - see [below for nested schema](#nestedblock--flow--stage--group--sub_alerts)) +- `sub_alerts` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--flow--stage--group--sub_alerts)) - ### Nested Schema for `flow.stage.group.sub_alerts` Required: -- `flow_alert` (Block List, Min: 1) ( - see [below for nested schema](#nestedblock--flow--stage--group--sub_alerts--flow_alert)) +- `flow_alert` (Block List, Min: 1) (see [below for nested schema](#nestedblock--flow--stage--group--sub_alerts--flow_alert)) - `operator` (String) The operator to use on the alert. can be one of ["AND" "OR"] - ### Nested Schema for `flow.stage.group.sub_alerts.flow_alert` Required: @@ -598,8 +103,10 @@ Optional: - `not` (Boolean) - + + + ### Nested Schema for `flow.stage.time_window` Optional: @@ -608,8 +115,10 @@ Optional: - `minutes` (Number) - `seconds` (Number) - + + + ### Nested Schema for `incident_settings` Required: @@ -618,12 +127,10 @@ Required: Optional: -- `notify_on` (String) Defines the alert's triggering logic. Can be one of ["Triggered_only" "Triggered_and_resolved"]. - Triggered_and_resolved conflicts with new_value, unique_count and flow alerts, and with immediately and - more_than_usual conditions +- `notify_on` (String) Defines the alert's triggering logic. Can be one of ["Triggered_only" "Triggered_and_resolved"]. Triggered_and_resolved conflicts with new_value, unique_count and flow alerts, and with immediately and more_than_usual conditions - + ### Nested Schema for `metric` Optional: @@ -632,81 +139,64 @@ Optional: - `promql` (Block List, Max: 1) (see [below for nested schema](#nestedblock--metric--promql)) - ### Nested Schema for `metric.lucene` Required: -- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert ( - see [below for nested schema](#nestedblock--metric--lucene--condition)) +- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert (see [below for nested schema](#nestedblock--metric--lucene--condition)) - `search_query` (String) Regular expiration. More info: https://coralogix.com/blog/regex-101/ - ### Nested Schema for `metric.lucene.condition` Required: -- `arithmetic_operator` (String) The arithmetic operator to use on the alert. can be one - of ["Count" "Percentile" "Avg" "Min" "Max" "Sum"] +- `arithmetic_operator` (String) The arithmetic operator to use on the alert. can be one of ["Count" "Percentile" "Avg" "Min" "Max" "Sum"] - `metric_field` (String) The name of the metric field to alert on. -- `sample_threshold_percentage` (Number) The metric value must cross the threshold within this percentage of the - timeframe (sum and count arithmetic operators do not use this parameter since they aggregate over the entire requested - timeframe), increments of 10, 0 <= value <= 100. +- `sample_threshold_percentage` (Number) The metric value must cross the threshold within this percentage of the timeframe (sum and count arithmetic operators do not use this parameter since they aggregate over the entire requested timeframe), increments of 10, 0 <= value <= 100. - `threshold` (Number) The number of log threshold that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be - one of ["24H" "1Min" "10Min" "15Min" "2H" "12H" "6H" "5Min" "20Min" "30Min" "1H" "4H"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1Min" "15Min" "20Min" "1H" "2H" "4H" "6H" "12H" "24H" "5Min" "10Min" "30Min"] Optional: -- `arithmetic_operator_modifier` (Number) When arithmetic_operator = "Percentile" you need to supply the value in this - property, 0 < value < 100. +- `arithmetic_operator_modifier` (Number) When arithmetic_operator = "Percentile" you need to supply the value in this property, 0 < value < 100. - `group_by` (List of String) The fields to 'group by' on. - `less_than` (Boolean) Determines the condition operator. Must be one of - less_than or more_than. -- `manage_undetected_values` (Block List, Max: 1) Manage your logs undetected values - when relevant, enable/disable - triggering on undetected values and change the auto retire interval. By default (when relevant), triggering is enabled - with retire-ratio=NEVER. ( - see [below for nested schema](#nestedblock--metric--lucene--condition--manage_undetected_values)) -- `min_non_null_values_percentage` (Number) The minimum percentage of the timeframe that should have values for this - alert to trigger +- `manage_undetected_values` (Block List, Max: 1) Manage your logs undetected values - when relevant, enable/disable triggering on undetected values and change the auto retire interval. By default (when relevant), triggering is enabled with retire-ratio=NEVER. (see [below for nested schema](#nestedblock--metric--lucene--condition--manage_undetected_values)) +- `min_non_null_values_percentage` (Number) The minimum percentage of the timeframe that should have values for this alert to trigger - `more_than` (Boolean) Determines the condition operator. Must be one of - less_than or more_than. -- `replace_missing_value_with_zero` (Boolean) If set to true, missing data will be considered as 0, otherwise, it will - not be considered at all. +- `replace_missing_value_with_zero` (Boolean) If set to true, missing data will be considered as 0, otherwise, it will not be considered at all. - ### Nested Schema for `metric.lucene.condition.manage_undetected_values` Required: -- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, - auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. +- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one - of ["5Min" "10Min" "1H" "2H" "6H" "12H" "24H" "Never"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] + + - + ### Nested Schema for `metric.promql` Required: -- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert ( - see [below for nested schema](#nestedblock--metric--promql--condition)) +- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert (see [below for nested schema](#nestedblock--metric--promql--condition)) - `search_query` (String) Regular expiration. More info: https://coralogix.com/blog/regex-101/ - ### Nested Schema for `metric.promql.condition` Required: - `sample_threshold_percentage` (Number) - `threshold` (Number) The threshold that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be - one of ["24H" "1Min" "10Min" "15Min" "2H" "12H" "6H" "5Min" "20Min" "30Min" "1H" "4H"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1Min" "15Min" "20Min" "1H" "2H" "4H" "6H" "12H" "24H" "5Min" "10Min" "30Min"] Optional: @@ -721,103 +211,85 @@ Optional: - `replace_missing_value_with_zero` (Boolean) If set to true, missing data will be considered as 0, otherwise, it will not be considered at all. - ### Nested Schema for `metric.promql.condition.manage_undetected_values` Required: -- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, - auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. +- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one - of ["5Min" "10Min" "1H" "2H" "6H" "12H" "24H" "Never"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] + + + - + ### Nested Schema for `new_value` Required: -- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert ( - see [below for nested schema](#nestedblock--new_value--condition)) +- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert (see [below for nested schema](#nestedblock--new_value--condition)) Optional: -- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. - Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter: - endsWith:xxx, filter:contains:xxx +- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `categories` (Set of String) An array that contains log’s categories that we want to be notified on. - `classes` (Set of String) An array that contains log’s class names that we want to be notified on. - `computers` (Set of String) An array that contains log’s computer names that we want to be notified on. - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one - of ["Verbose" "Info" "Warning" "Error" "Critical" "Debug"] -- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems - can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, - filter:contains:xxx +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - ### Nested Schema for `new_value.condition` Required: -- `key_to_track` (String) Select a key to track. Note, this key needs to have less than 50K unique values in the defined - timeframe. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be - one of ["24H" "48H" "72H" "1W" "1Month" "2Month" "3Month" "12H"] +- `key_to_track` (String) Select a key to track. Note, this key needs to have less than 50K unique values in the defined timeframe. +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["12H" "24H" "48H" "72H" "1W" "1Month" "2Month" "3Month"] - + + ### Nested Schema for `notifications_group` Optional: -- `group_by_fields` (List of String) List of group-by fields to apply the notification logic on (can be empty). Every - notification should contain unique group_by_fields permutation (the order doesn't matter). -- `notification` (Block Set) Defines notification logic with optional recipients. Can contain single webhook or email - recipients list. (see [below for nested schema](#nestedblock--notifications_group--notification)) +- `group_by_fields` (List of String) List of group-by fields to apply the notification logic on (can be empty). Every notification should contain unique group_by_fields permutation (the order doesn't matter). +- `notification` (Block Set) Defines notification logic with optional recipients. Can contain single webhook or email recipients list. (see [below for nested schema](#nestedblock--notifications_group--notification)) - ### Nested Schema for `notifications_group.notification` Optional: - `email_recipients` (Set of String) Conflicts with integration_id. - `integration_id` (String) Conflicts with emails. -- `notify_on` (String) Defines the alert's triggering logic. Can be one of ["Triggered_only" "Triggered_and_resolved"]. - Triggered_and_resolved conflicts with new_value, unique_count and flow alerts, and with immediately and - more_than_usual conditions -- `retriggering_period_minutes` (Number) By default, retriggering_period_minutes will be populated with min for - immediate, more_than and more_than_usual alerts. For less_than alert it will be populated with the chosen time frame - for the less_than condition (in minutes). You may choose to change the suppress window so the alert will be suppressed - for a longer period. +- `notify_on` (String) Defines the alert's triggering logic. Can be one of ["Triggered_only" "Triggered_and_resolved"]. Triggered_and_resolved conflicts with new_value, unique_count and flow alerts, and with immediately and more_than_usual conditions +- `retriggering_period_minutes` (Number) By default, retriggering_period_minutes will be populated with min for immediate, more_than and more_than_usual alerts. For less_than alert it will be populated with the chosen time frame for the less_than condition (in minutes). You may choose to change the suppress window so the alert will be suppressed for a longer period. + - + ### Nested Schema for `ratio` Required: -- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert ( - see [below for nested schema](#nestedblock--ratio--condition)) +- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert (see [below for nested schema](#nestedblock--ratio--condition)) - `query_1` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--ratio--query_1)) - `query_2` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--ratio--query_2)) - ### Nested Schema for `ratio.condition` Required: - `ratio_threshold` (Number) The ratio(between the queries) threshold that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be - one of ["10Min" "1H" "2H" "6H" "24H" "5Min" "15Min" "20Min" "30Min" "4H" "12H" "36H"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1H" "2H" "6H" "24H" "10Min" "15Min" "30Min" "4H" "12H" "36H" "5Min" "20Min"] Optional: @@ -827,122 +299,99 @@ Optional: - `group_by_q2` (Boolean) - `ignore_infinity` (Boolean) Not triggered when threshold is infinity (divided by zero). - `less_than` (Boolean) -- `manage_undetected_values` (Block List, Max: 1) Manage your logs undetected values - when relevant, enable/disable - triggering on undetected values and change the auto retire interval. By default (when relevant), triggering is enabled - with retire-ratio=NEVER. (see [below for nested schema](#nestedblock--ratio--condition--manage_undetected_values)) +- `manage_undetected_values` (Block List, Max: 1) Manage your logs undetected values - when relevant, enable/disable triggering on undetected values and change the auto retire interval. By default (when relevant), triggering is enabled with retire-ratio=NEVER. (see [below for nested schema](#nestedblock--ratio--condition--manage_undetected_values)) - `more_than` (Boolean) Determines the condition operator. Must be one of - less_than or more_than. - ### Nested Schema for `ratio.condition.manage_undetected_values` Required: -- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, - auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. +- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one - of ["5Min" "10Min" "1H" "2H" "6H" "12H" "24H" "Never"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] + - + ### Nested Schema for `ratio.query_1` Optional: - `alias` (String) Query1 alias. -- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. - Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter: - endsWith:xxx, filter:contains:xxx +- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `categories` (Set of String) An array that contains log’s categories that we want to be notified on. - `classes` (Set of String) An array that contains log’s class names that we want to be notified on. - `computers` (Set of String) An array that contains log’s computer names that we want to be notified on. - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one - of ["Verbose" "Info" "Warning" "Error" "Critical" "Debug"] -- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems - can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, - filter:contains:xxx +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - + ### Nested Schema for `ratio.query_2` Optional: - `alias` (String) Query2 alias. -- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. - Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter: - endsWith:xxx, filter:contains:xxx +- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one - of ["Verbose" "Info" "Warning" "Error" "Critical" "Debug"] -- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems - can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, - filter:contains:xxx +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx + - + ### Nested Schema for `scheduling` Required: -- `time_frame` (Block Set, Min: 1, Max: 1) time_frame is a set of days and hours when the alert will be active. *** - Currently, supported only for one time_frame*** (see [below for nested schema](#nestedblock--scheduling--time_frame)) +- `time_frame` (Block Set, Min: 1, Max: 1) time_frame is a set of days and hours when the alert will be active. ***Currently, supported only for one time_frame*** (see [below for nested schema](#nestedblock--scheduling--time_frame)) Optional: -- `time_zone` (String) Specifies the time zone to be used in interpreting the schedule. Can be one - of ["UTC-11" "UTC-10" "UTC-9" "UTC-8" "UTC-7" "UTC-6" "UTC-5" "UTC-4" "UTC-3" "UTC-2" "UTC-1" "UTC+0" "UTC+1" "UTC+2" "UTC+3" "UTC+4" "UTC+5" "UTC+6" "UTC+7" "UTC+8" "UTC+9" "UTC+10" "UTC+11" "UTC+12" "UTC+13" "UTC+14"] +- `time_zone` (String) Specifies the time zone to be used in interpreting the schedule. Can be one of ["UTC-11" "UTC-10" "UTC-9" "UTC-8" "UTC-7" "UTC-6" "UTC-5" "UTC-4" "UTC-3" "UTC-2" "UTC-1" "UTC+0" "UTC+1" "UTC+2" "UTC+3" "UTC+4" "UTC+5" "UTC+6" "UTC+7" "UTC+8" "UTC+9" "UTC+10" "UTC+11" "UTC+12" "UTC+13" "UTC+14"] - ### Nested Schema for `scheduling.time_frame` Required: -- `days_enabled` (Set of String) Days of week. Can be one - of ["Friday" "Saturday" "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday"] +- `days_enabled` (Set of String) Days of week. Can be one of ["Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"] - `end_time` (String) Limit the triggering of this alert to end at specific hour. - `start_time` (String) Limit the triggering of this alert to start at specific hour. - + + ### Nested Schema for `standard` Required: -- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert ( - see [below for nested schema](#nestedblock--standard--condition)) +- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert (see [below for nested schema](#nestedblock--standard--condition)) Optional: -- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. - Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter: - endsWith:xxx, filter:contains:xxx +- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `categories` (Set of String) An array that contains log’s categories that we want to be notified on. - `classes` (Set of String) An array that contains log’s class names that we want to be notified on. - `computers` (Set of String) An array that contains log’s computer names that we want to be notified on. - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one - of ["Verbose" "Info" "Warning" "Error" "Critical" "Debug"] -- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems - can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, - filter:contains:xxx +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx ### Nested Schema for `standard.condition` Optional: -- `evaluation_window` (String) Defines the evaluation-window logic to determine if the threshold has been crossed. - Relevant only for more_than condition. Can be one of ["Rolling" "Dynamic"]. +- `evaluation_window` (String) Defines the evaluation-window logic to determine if the threshold has been crossed. Relevant only for more_than condition. Can be one of ["Rolling" "Dynamic"]. - `group_by` (List of String) The fields to 'group by' on. In case of immediately = true switch to group_by_key. - `group_by_key` (String) The key to 'group by' on. When immediately = true, 'group_by_key' (single string) can be set instead of 'group_by'. - `immediately` (Boolean) Determines the condition operator. Must be one of - immediately, less_than, more_than or more_than_usual. @@ -951,86 +400,72 @@ Optional: - `more_than` (Boolean) Determines the condition operator. Must be one of - immediately, less_than, more_than or more_than_usual. - `more_than_usual` (Boolean) Determines the condition operator. Must be one of - immediately, less_than, more_than or more_than_usual. - `threshold` (Number) The number of log occurrences that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["6H" "12H" "24H" "15Min" "20Min" "30Min" "2H" "4H" "36H" "5Min" "10Min" "1H"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1H" "2H" "6H" "24H" "10Min" "15Min" "30Min" "4H" "12H" "36H" "5Min" "20Min"] - ### Nested Schema for `standard.condition.manage_undetected_values` Required: -- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, - auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. +- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one - of ["5Min" "10Min" "1H" "2H" "6H" "12H" "24H" "Never"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] - + + + ### Nested Schema for `time_relative` Required: -- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert ( - see [below for nested schema](#nestedblock--time_relative--condition)) +- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert (see [below for nested schema](#nestedblock--time_relative--condition)) Optional: -- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. - Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter: - endsWith:xxx, filter:contains:xxx +- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `categories` (Set of String) An array that contains log’s categories that we want to be notified on. - `classes` (Set of String) An array that contains log’s class names that we want to be notified on. - `computers` (Set of String) An array that contains log’s computer names that we want to be notified on. - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one - of ["Verbose" "Info" "Warning" "Error" "Critical" "Debug"] -- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems - can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, - filter:contains:xxx +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - ### Nested Schema for `time_relative.condition` Required: - `ratio_threshold` (Number) The ratio threshold that is needed to trigger the alert. -- `relative_time_window` (String) Time-window to compare with. Can be one - of ["Previous_hour" "Same_hour_yesterday" "Same_hour_last_week" "Yesterday" "Same_day_last_week" "Same_day_last_month"] - . +- `relative_time_window` (String) Time-window to compare with. Can be one of ["Previous_hour" "Same_hour_yesterday" "Same_hour_last_week" "Yesterday" "Same_day_last_week" "Same_day_last_month"]. Optional: - `group_by` (List of String) The fields to 'group by' on. - `ignore_infinity` (Boolean) Not triggered when threshold is infinity (divided by zero). - `less_than` (Boolean) Determines the condition operator. Must be one of - less_than or more_than. -- `manage_undetected_values` (Block List, Max: 1) Manage your logs undetected values - when relevant, enable/disable - triggering on undetected values and change the auto retire interval. By default (when relevant), triggering is enabled - with retire-ratio=NEVER. ( - see [below for nested schema](#nestedblock--time_relative--condition--manage_undetected_values)) +- `manage_undetected_values` (Block List, Max: 1) Manage your logs undetected values - when relevant, enable/disable triggering on undetected values and change the auto retire interval. By default (when relevant), triggering is enabled with retire-ratio=NEVER. (see [below for nested schema](#nestedblock--time_relative--condition--manage_undetected_values)) - `more_than` (Boolean) Determines the condition operator. Must be one of - less_than or more_than. - ### Nested Schema for `time_relative.condition.manage_undetected_values` Required: -- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, - auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. +- `enable_triggering_on_undetected_values` (Boolean) Determines whether the deadman-option is enabled. When set to true, auto_retire_ratio is required otherwise auto_retire_ratio should be omitted. Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one - of ["5Min" "10Min" "1H" "2H" "6H" "12H" "24H" "Never"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] + + - + ### Nested Schema for `timeouts` Optional: @@ -1040,31 +475,23 @@ Optional: - `read` (String) - `update` (String) - + ### Nested Schema for `tracing` Required: -- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert ( - see [below for nested schema](#nestedblock--tracing--condition)) +- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert (see [below for nested schema](#nestedblock--tracing--condition)) Optional: -- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. - Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:notEquals:xxx, filter: - startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx +- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:notEquals:xxx, filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `latency_threshold_milliseconds` (Number) -- `services` (Set of String) An array that contains log’s services names that we want to be alerted on. Applications can - be filtered by prefix, suffix, and contains using the next patterns - filter:notEquals:xxx, filter:startsWith:xxx, - filter:endsWith:xxx, filter:contains:xxx -- `subsystems` (Set of String) An array that contains log’s subsystems names that we want to be alerted on. Applications - can be filtered by prefix, suffix, and contains using the next patterns - filter:notEquals:xxx, filter:startsWith:xxx, - filter:endsWith:xxx, filter:contains:xxx +- `services` (Set of String) An array that contains log’s services names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:notEquals:xxx, filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx +- `subsystems` (Set of String) An array that contains log’s subsystems names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:notEquals:xxx, filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `tag_filter` (Block Set) (see [below for nested schema](#nestedblock--tracing--tag_filter)) - ### Nested Schema for `tracing.condition` Optional: @@ -1073,70 +500,48 @@ Optional: - `immediately` (Boolean) Determines the condition operator. Must be one of - immediately or more_than. - `more_than` (Boolean) Determines the condition operator. Must be one of - immediately or more_than. - `threshold` (Number) The number of log occurrences that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be - one of ["10Min" "1H" "2H" "6H" "24H" "5Min" "15Min" "20Min" "30Min" "4H" "12H" "36H"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1H" "2H" "6H" "24H" "10Min" "15Min" "30Min" "4H" "12H" "36H" "5Min" "20Min"] - + ### Nested Schema for `tracing.tag_filter` Required: - `field` (String) -- `values` (Set of String) Tag filter values can be filtered by prefix, suffix, and contains using the next patterns - - filter:notEquals:xxx, filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx +- `values` (Set of String) Tag filter values can be filtered by prefix, suffix, and contains using the next patterns - filter:notEquals:xxx, filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - + + ### Nested Schema for `unique_count` Required: -- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert ( - see [below for nested schema](#nestedblock--unique_count--condition)) +- `condition` (Block List, Min: 1, Max: 1) Defines the conditions for triggering and notify by the alert (see [below for nested schema](#nestedblock--unique_count--condition)) Optional: -- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. - Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter: - endsWith:xxx, filter:contains:xxx +- `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `categories` (Set of String) An array that contains log’s categories that we want to be notified on. - `classes` (Set of String) An array that contains log’s class names that we want to be notified on. - `computers` (Set of String) An array that contains log’s computer names that we want to be notified on. - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one - of ["Verbose" "Info" "Warning" "Error" "Critical" "Debug"] -- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems - can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, - filter:contains:xxx +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - ### Nested Schema for `unique_count.condition` Required: - `max_unique_values` (Number) -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["15Min" "20Min" "30Min" "1H" "6H" "12H" "1Min" "5Min" "4H" "24H" "10Min" "2H"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["6H" "12H" "15Min" "20Min" "30Min" "1H" "4H" "24H" "1Min" "5Min" "10Min" "2H"] - `unique_count_key` (String) Defines the key to match to track its unique count. Optional: - `group_by_key` (String) The key to 'group by' on. - `max_unique_values_for_group_by` (Number) - -### Import -```sh -terraform import coralogix_alert.example -``` - -to get the alert id run the following command and look for the **uniqueIdentifier (and not id)** field of the alert you want to import: -```sh -grpcurl -H "Authorization: Bearer " -d @ ng-api-grpc.:443 com.coralogix.alerts.v2.AlertService/GetAlerts < ## Schema @@ -138,7 +101,7 @@ Optional: - `end_time` (String) The end time of the time frame. In a isodate format. For example, `2021-01-01T00:00:00.000`. -### Nested Schema for `schedule.one_time.time_frame.end_time` +### Nested Schema for `schedule.one_time.time_frame.duration` Required: @@ -169,28 +132,28 @@ Optional: - `termination_date` (String) -### Nested Schema for `schedule.recurring.dynamic.termination_date` +### Nested Schema for `schedule.recurring.dynamic.frequency` Optional: -- `daily` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--termination_date--daily)) -- `monthly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--termination_date--monthly)) -- `weekly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--termination_date--weekly)) +- `daily` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--daily)) +- `monthly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--monthly)) +- `weekly` (Attributes) (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--frequency--weekly)) - -### Nested Schema for `schedule.recurring.dynamic.termination_date.daily` + +### Nested Schema for `schedule.recurring.dynamic.frequency.daily` - -### Nested Schema for `schedule.recurring.dynamic.termination_date.monthly` + +### Nested Schema for `schedule.recurring.dynamic.frequency.monthly` Optional: - `days` (Set of Number) - -### Nested Schema for `schedule.recurring.dynamic.termination_date.weekly` + +### Nested Schema for `schedule.recurring.dynamic.frequency.weekly` Optional: @@ -199,7 +162,7 @@ Optional: -### Nested Schema for `schedule.recurring.dynamic.termination_date` +### Nested Schema for `schedule.recurring.dynamic.time_frame` Required: @@ -208,18 +171,13 @@ Required: Optional: -- `duration` (Attributes) The duration from the start time to wait. (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--termination_date--duration)) +- `duration` (Attributes) The duration from the start time to wait. (see [below for nested schema](#nestedatt--schedule--recurring--dynamic--time_frame--duration)) - `end_time` (String) The end time of the time frame. In a isodate format. For example, `2021-01-01T00:00:00.000`. - -### Nested Schema for `schedule.recurring.dynamic.termination_date.duration` + +### Nested Schema for `schedule.recurring.dynamic.time_frame.duration` Required: - `for_over` (Number) The number of time units to wait before the alert is triggered. For example, if the frequency is set to `hours` and the value is set to `2`, the alert will be triggered after 2 hours. - `frequency` (String) The time unit to wait before the alert is triggered. Can be `minutes`, `hours` or `days`. - -### Import -```sh -terraform import coralogix_alerts_scheduler.example -``` \ No newline at end of file diff --git a/docs/resources/api_key.md b/docs/resources/api_key.md index 092a9600..637ec946 100644 --- a/docs/resources/api_key.md +++ b/docs/resources/api_key.md @@ -11,21 +11,6 @@ description: |- Coralogix Api keys. -## Example Usage - -```hcl -resource "coralogix_api_key" "example" { - name = "My SCIM KEY" - owner = { - team_id : "4013254" - } - active = true - hashed = false - presets = ["admin", "some-other-preset"] - permissions = ["Alerts/Write"] -} -``` - ## Schema diff --git a/docs/resources/archive_logs.md b/docs/resources/archive_logs.md index 011ed2c6..ad61b01d 100644 --- a/docs/resources/archive_logs.md +++ b/docs/resources/archive_logs.md @@ -8,13 +8,7 @@ description: |- # coralogix_archive_logs (Resource) -## Example Usage -```hcl -resource "coralogix_archive_logs" "example" { - bucket = "example-bucket" -} -``` diff --git a/docs/resources/archive_metrics.md b/docs/resources/archive_metrics.md index c0391799..b36add5c 100644 --- a/docs/resources/archive_metrics.md +++ b/docs/resources/archive_metrics.md @@ -8,16 +8,7 @@ description: |- # coralogix_archive_metrics (Resource) -## Example Usage - -```hcl -resource "coralogix_archive_metrics" example { - s3 = { - region = "eu-north-1" - bucket = "coralogix-c4c-eu2-prometheus-data" - } -} -``` + diff --git a/docs/resources/archive_retentions.md b/docs/resources/archive_retentions.md index bb890811..58115bc6 100644 --- a/docs/resources/archive_retentions.md +++ b/docs/resources/archive_retentions.md @@ -10,25 +10,6 @@ description: |- Coralogix archive-retention. For more info please review - https://coralogix.com/docs/archive-setup-grpc-api/. -## Example Usage - -```hcl -resource "coralogix_archive_retentions" "example" { - retentions = [ - { - }, - { - name = "retention2" - }, - { - name = "retention3" - }, - { - name = "retention4" - }, - ] -} -``` diff --git a/docs/resources/custom_role.md b/docs/resources/custom_role.md index f8cedcf7..08a19661 100644 --- a/docs/resources/custom_role.md +++ b/docs/resources/custom_role.md @@ -3,28 +3,13 @@ page_title: "coralogix_custom_role Resource - terraform-provider-coralogix" subcategory: "" description: |- -Coralogix Custom roles. + Coralogix Custom roles. --- # coralogix_custom_role (Resource) Coralogix Custom roles. -## Example Usage - -```hcl -resource "coralogix_custom_role" "example" { - name = "Example custom role" - description = "This role is created with terraform!" - parent_role = "Standard User" - permissions = ["spans.events2metrics:UpdateConfig"] -} - -resource "coralogix_group" "example" { - display_name = "example" - role = coralogix_custom_role.example.name -} -``` @@ -40,18 +25,3 @@ resource "coralogix_group" "example" { ### Read-Only - `id` (String) Custom Role ID. - -### Import - -```sh -terraform import coralogix_custom_role.example -``` - -to get the custom role id you can use the following command: -```sh -grpcurl -H "Authorization: Bearer " -d @ ng-api-grpc.:443 com.coralogixapis.aaa.rbac.v2.RoleManagementService/ListCustomRoles < @@ -670,24 +68,24 @@ Optional: - `message_template` (String) -### Nested Schema for `annotations.source.logs.message_template` +### Nested Schema for `annotations.source.logs.strategy` Optional: -- `duration` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--message_template--duration)) -- `instant` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--message_template--instant)) -- `range` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--message_template--range)) +- `duration` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--duration)) +- `instant` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--instant)) +- `range` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--range)) - -### Nested Schema for `annotations.source.logs.message_template.duration` + +### Nested Schema for `annotations.source.logs.strategy.duration` Required: -- `duration_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--message_template--duration--duration_field)) -- `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--message_template--duration--start_timestamp_field)) +- `duration_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--duration--duration_field)) +- `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--duration--start_timestamp_field)) - -### Nested Schema for `annotations.source.logs.message_template.duration.start_timestamp_field` + +### Nested Schema for `annotations.source.logs.strategy.duration.duration_field` Required: @@ -695,8 +93,8 @@ Required: - `scope` (String) - -### Nested Schema for `annotations.source.logs.message_template.duration.start_timestamp_field` + +### Nested Schema for `annotations.source.logs.strategy.duration.start_timestamp_field` Required: @@ -705,15 +103,15 @@ Required: - -### Nested Schema for `annotations.source.logs.message_template.instant` + +### Nested Schema for `annotations.source.logs.strategy.instant` Required: -- `timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--message_template--instant--timestamp_field)) +- `timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--instant--timestamp_field)) - -### Nested Schema for `annotations.source.logs.message_template.instant.timestamp_field` + +### Nested Schema for `annotations.source.logs.strategy.instant.timestamp_field` Required: @@ -722,16 +120,16 @@ Required: - -### Nested Schema for `annotations.source.logs.message_template.range` + +### Nested Schema for `annotations.source.logs.strategy.range` Required: -- `end_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--message_template--range--end_timestamp_field)) -- `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--message_template--range--start_timestamp_field)) +- `end_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--range--end_timestamp_field)) +- `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--logs--strategy--range--start_timestamp_field)) - -### Nested Schema for `annotations.source.logs.message_template.range.start_timestamp_field` + +### Nested Schema for `annotations.source.logs.strategy.range.end_timestamp_field` Required: @@ -739,8 +137,8 @@ Required: - `scope` (String) - -### Nested Schema for `annotations.source.logs.message_template.range.start_timestamp_field` + +### Nested Schema for `annotations.source.logs.strategy.range.start_timestamp_field` Required: @@ -751,7 +149,7 @@ Required: -### Nested Schema for `annotations.source.logs.message_template` +### Nested Schema for `annotations.source.logs.label_fields` Required: @@ -774,14 +172,14 @@ Optional: - `message_template` (String) -### Nested Schema for `annotations.source.metrics.message_template` +### Nested Schema for `annotations.source.metrics.strategy` Required: -- `start_time` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--metrics--message_template--start_time)) +- `start_time` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--metrics--strategy--start_time)) - -### Nested Schema for `annotations.source.metrics.message_template.start_time` + +### Nested Schema for `annotations.source.metrics.strategy.start_time` @@ -800,24 +198,24 @@ Optional: - `message_template` (String) -### Nested Schema for `annotations.source.spans.message_template` +### Nested Schema for `annotations.source.spans.strategy` Optional: -- `duration` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--message_template--duration)) -- `instant` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--message_template--instant)) -- `range` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--message_template--range)) +- `duration` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--duration)) +- `instant` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--instant)) +- `range` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--range)) - -### Nested Schema for `annotations.source.spans.message_template.duration` + +### Nested Schema for `annotations.source.spans.strategy.duration` Required: -- `duration_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--message_template--duration--duration_field)) -- `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--message_template--duration--start_timestamp_field)) +- `duration_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--duration--duration_field)) +- `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--duration--start_timestamp_field)) - -### Nested Schema for `annotations.source.spans.message_template.duration.start_timestamp_field` + +### Nested Schema for `annotations.source.spans.strategy.duration.duration_field` Required: @@ -825,8 +223,8 @@ Required: - `scope` (String) - -### Nested Schema for `annotations.source.spans.message_template.duration.start_timestamp_field` + +### Nested Schema for `annotations.source.spans.strategy.duration.start_timestamp_field` Required: @@ -835,15 +233,15 @@ Required: - -### Nested Schema for `annotations.source.spans.message_template.instant` + +### Nested Schema for `annotations.source.spans.strategy.instant` Required: -- `timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--message_template--instant--timestamp_field)) +- `timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--instant--timestamp_field)) - -### Nested Schema for `annotations.source.spans.message_template.instant.timestamp_field` + +### Nested Schema for `annotations.source.spans.strategy.instant.timestamp_field` Required: @@ -852,16 +250,16 @@ Required: - -### Nested Schema for `annotations.source.spans.message_template.range` + +### Nested Schema for `annotations.source.spans.strategy.range` Required: -- `end_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--message_template--range--end_timestamp_field)) -- `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--message_template--range--start_timestamp_field)) +- `end_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--range--end_timestamp_field)) +- `start_timestamp_field` (Attributes) (see [below for nested schema](#nestedatt--annotations--source--spans--strategy--range--start_timestamp_field)) - -### Nested Schema for `annotations.source.spans.message_template.range.start_timestamp_field` + +### Nested Schema for `annotations.source.spans.strategy.range.end_timestamp_field` Required: @@ -869,8 +267,8 @@ Required: - `scope` (String) - -### Nested Schema for `annotations.source.spans.message_template.range.start_timestamp_field` + +### Nested Schema for `annotations.source.spans.strategy.range.start_timestamp_field` Required: @@ -881,7 +279,7 @@ Required: -### Nested Schema for `annotations.source.spans.message_template` +### Nested Schema for `annotations.source.spans.label_fields` Required: @@ -934,7 +332,7 @@ Optional: - `observation_field` (Attributes) (see [below for nested schema](#nestedatt--filters--source--logs--observation_field)) -### Nested Schema for `filters.source.logs.observation_field` +### Nested Schema for `filters.source.logs.operator` Required: @@ -986,7 +384,7 @@ Required: - `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--filters--source--spans--operator)) -### Nested Schema for `filters.source.spans.operator` +### Nested Schema for `filters.source.spans.field` Required: @@ -1067,11 +465,11 @@ Read-Only: - `id` (String) -### Nested Schema for `layout.sections.rows.id` +### Nested Schema for `layout.sections.rows.widgets` Required: -- `definition` (Attributes) The widget definition. Can contain one of 'line_chart', 'data_table', 'gauge', 'pie_chart', 'bar_chart', 'horizontal_bar_chart', 'markdown'. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition)) +- `definition` (Attributes) The widget definition. Can contain one of 'line_chart', 'data_table', 'gauge', 'pie_chart', 'bar_chart', 'horizontal_bar_chart', 'markdown'. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition)) Optional: @@ -1083,21 +481,21 @@ Read-Only: - `id` (String) - -### Nested Schema for `layout.sections.rows.id.definition` + +### Nested Schema for `layout.sections.rows.widgets.definition` Optional: -- `bar_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--bar_chart)) -- `data_table` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--data_table)) -- `gauge` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--gauge)) -- `horizontal_bar_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--horizontal_bar_chart)) -- `line_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--line_chart)) -- `markdown` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--markdown)) -- `pie_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart)) +- `bar_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart)) +- `data_table` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table)) +- `gauge` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge)) +- `horizontal_bar_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart)) +- `line_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart)) +- `markdown` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--markdown)) +- `pie_chart` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart` Optional: @@ -1106,25 +504,25 @@ Optional: - `data_mode_type` (String) - `group_name_template` (String) - `max_bars_per_chart` (Number) -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--query)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query)) - `scale_type` (String) - `sort_by` (String) The field to sort by. Can be one of unspecified, value, name. -- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--stack_definition)) -- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, seconds, kbytes, mbytes, gbytes, mibytes, gibytes, usd_cents, bytes_iec, euro, microseconds, bytes, kibytes, euro_cents, usd. -- `xaxis` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis)) +- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--stack_definition)) +- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. +- `xaxis` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--xaxis)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query` Optional: -- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--data_prime)) -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans)) +- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime` Required: @@ -1132,33 +530,33 @@ Required: Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters)) - `group_names` (List of String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters` Optional: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.logs` Required: - `field` (String) Field in the logs to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--logs--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--spans--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--logs--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.spans.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.logs.operator` Required: @@ -1169,8 +567,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.spans.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.logs.observation_field` Required: @@ -1179,17 +577,17 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.metrics` Required: - `label` (String) - `metric_name` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--metrics--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.metrics.operator` Required: @@ -1201,16 +599,16 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.spans` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--spans--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--spans--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--spans--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--data_prime--filters--spans--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.spans.field` Required: @@ -1218,8 +616,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.data_prime.filters.spans.operator` Required: @@ -1233,24 +631,24 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs` Required: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--aggregation)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--aggregation)) Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--filters)) - `group_names` (List of String) -- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--group_names_fields)) +- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--group_names_fields)) - `lucene_query` (String) - `stacked_group_name` (String) -- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--stacked_group_name_field)) +- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--stacked_group_name_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.aggregation` Required: @@ -1259,11 +657,11 @@ Required: Optional: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--aggregation--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.aggregation.percent` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.aggregation.observation_field` Required: @@ -1272,20 +670,20 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.filters` Required: - `field` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--filters--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--logs--filters--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.filters.operator` Required: @@ -1296,8 +694,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.filters.observation_field` Required: @@ -1306,8 +704,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.group_names_fields` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.group_names_fields` Required: @@ -1315,8 +713,8 @@ Required: - `scope` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.stacked_group_name_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.logs.stacked_group_name_field` Required: @@ -1325,8 +723,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.metrics` Required: @@ -1334,24 +732,24 @@ Required: Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--metrics--filters)) - `group_names` (List of String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.metrics.filters` Required: - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--metrics--filters--operator)) Optional: - `label` (String) Label associated with the metric. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.label` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.metrics.filters.operator` Required: @@ -1364,37 +762,37 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans` Optional: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters)) -- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--group_names)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--filters)) +- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--group_names)) - `lucene_query` (String) -- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--stacked_group_name)) +- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--stacked_group_name)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.aggregation` Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.filters` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.filters.field` Required: @@ -1402,8 +800,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.filters.operator` Required: @@ -1415,8 +813,8 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.group_names` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.group_names` Required: @@ -1424,8 +822,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.spans.stacked_group_name` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.query.spans.stacked_group_name` Required: @@ -1435,8 +833,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.stack_definition` Optional: @@ -1444,16 +842,16 @@ Optional: - `stack_name_template` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.xaxis` Optional: -- `time` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--time)) -- `value` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--xaxis--value)) +- `time` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--xaxis--time)) +- `value` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--xaxis--value)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.value` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.xaxis.time` Required: @@ -1464,68 +862,68 @@ Optional: - `buckets_presented` (Number) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.xaxis.value` + +### Nested Schema for `layout.sections.rows.widgets.definition.bar_chart.xaxis.value` - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table` Required: -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--query)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query)) - `results_per_page` (Number) The number of results to display per page. - `row_style` (String) The style of the rows. Can be one of ["one_line" "two_line" "condensed" "json"]. Optional: -- `columns` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--columns)) -- `data_mode_type` (String) The data mode type. Can be one of ["archive" "unspecified"]. -- `order_by` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by)) +- `columns` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--columns)) +- `data_mode_type` (String) The data mode type. Can be one of ["unspecified" "archive"]. +- `order_by` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--order_by)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query` Optional: -- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--data_prime)) -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans)) +- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime` Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters)) - `query` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters` Optional: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.logs` Required: - `field` (String) Field in the logs to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--logs--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--spans--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--logs--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.spans.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.logs.operator` Required: @@ -1536,8 +934,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.spans.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.logs.observation_field` Required: @@ -1546,17 +944,17 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.metrics` Required: - `label` (String) - `metric_name` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--metrics--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.metrics.operator` Required: @@ -1568,16 +966,16 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.spans` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--spans--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--spans--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--spans--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--data_prime--filters--spans--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.spans.field` Required: @@ -1585,8 +983,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.data_prime.filters.spans.operator` Required: @@ -1600,29 +998,29 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs` Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters)) -- `grouping` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--filters)) +- `grouping` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping)) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.filters` Required: - `field` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--filters--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--filters--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.filters.operator` Required: @@ -1633,8 +1031,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.filters.observation_field` Required: @@ -1643,21 +1041,21 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping` Optional: -- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping--aggregations)) +- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping--aggregations)) - `group_by` (List of String) -- `group_bys` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping--group_bys)) +- `group_bys` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping--group_bys)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping.group_bys` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping.aggregations` Required: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping--group_bys--aggregation)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping--aggregations--aggregation)) Optional: @@ -1665,8 +1063,8 @@ Optional: - `is_visible` (Boolean) - `name` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping.group_bys.name` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping.aggregations.aggregation` Required: @@ -1675,11 +1073,11 @@ Required: Optional: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping--group_bys--name--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--logs--grouping--aggregations--aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping.group_bys.name.percent` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping.aggregations.aggregation.observation_field` Required: @@ -1689,8 +1087,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping.group_bys` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.logs.grouping.group_bys` Required: @@ -1700,8 +1098,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.metrics` Required: @@ -1709,22 +1107,22 @@ Required: Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--metrics--filters)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.metrics.filters` Required: - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--metrics--filters--operator)) Optional: - `label` (String) Label associated with the metric. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.label` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.metrics.filters.operator` Required: @@ -1737,25 +1135,25 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans` Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters)) -- `grouping` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--filters)) +- `grouping` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--grouping)) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.filters` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.filters.field` Required: @@ -1763,8 +1161,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.filters.operator` Required: @@ -1776,20 +1174,20 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.grouping` Optional: -- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping--aggregations)) -- `group_by` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping--group_by)) +- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--grouping--aggregations)) +- `group_by` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--grouping--group_by)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping.group_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.grouping.aggregations` Optional: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--order_by--spans--grouping--group_by--aggregation)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query--spans--grouping--aggregations--aggregation)) - `is_visible` (Boolean) - `name` (String) @@ -1797,19 +1195,19 @@ Read-Only: - `id` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping.group_by.id` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.grouping.aggregations.aggregation` Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by.spans.grouping.group_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.query.spans.grouping.group_by` Required: @@ -1820,8 +1218,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.columns` Required: @@ -1832,8 +1230,8 @@ Optional: - `width` (Number) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.order_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.data_table.order_by` Optional: @@ -1842,65 +1240,65 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge` Required: -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--query)) -- `unit` (String) The unit of the gauge. Can be one of ["none" "kbytes" "mibytes" "bytes" "kibytes" "euro" "usd_cents" "usd" "microseconds" "milliseconds" "seconds" "euro_cents" "percent" "mbytes" "bytes_iec" "gbytes" "gibytes"]. +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query)) +- `unit` (String) The unit of the gauge. Can be one of ["percent" "gbytes" "bytes_iec" "kibytes" "gibytes" "none" "kbytes" "mibytes" "euro" "usd_cents" "seconds" "mbytes" "euro_cents" "usd" "microseconds" "bytes" "milliseconds"]. Optional: -- `data_mode_type` (String) The data mode type. Can be one of ["archive" "unspecified"]. +- `data_mode_type` (String) The data mode type. Can be one of ["unspecified" "archive"]. - `max` (Number) - `min` (Number) - `show_inner_arc` (Boolean) - `show_outer_arc` (Boolean) - `threshold_by` (String) The threshold by. Can be one of ["unspecified" "value" "background"]. -- `thresholds` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds)) +- `thresholds` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--thresholds)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query` Optional: -- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--data_prime)) -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans)) +- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime` Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters)) - `query` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters` Optional: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.logs` Required: - `field` (String) Field in the logs to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--logs--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--spans--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--logs--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.spans.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.logs.operator` Required: @@ -1911,8 +1309,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.spans.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.logs.observation_field` Required: @@ -1921,17 +1319,17 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.metrics` Required: - `label` (String) - `metric_name` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--metrics--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.metrics.operator` Required: @@ -1943,16 +1341,16 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.spans` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--spans--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--spans--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--spans--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--data_prime--filters--spans--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.spans.field` Required: @@ -1960,8 +1358,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.data_prime.filters.spans.operator` Required: @@ -1975,20 +1373,20 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs` Required: -- `logs_aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--logs_aggregation)) +- `logs_aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--logs_aggregation)) Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--filters)) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.logs_aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.logs_aggregation` Required: @@ -1997,11 +1395,11 @@ Required: Optional: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--logs_aggregation--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--logs_aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.logs_aggregation.percent` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.logs_aggregation.observation_field` Required: @@ -2010,20 +1408,20 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.filters` Required: - `field` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--filters--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--logs--filters--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.filters.operator` Required: @@ -2034,8 +1432,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.logs.filters.observation_field` Required: @@ -2045,8 +1443,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.metrics` Required: @@ -2054,23 +1452,23 @@ Required: Optional: -- `aggregation` (String) The type of aggregation. Can be one of ["max" "avg" "sum" "unspecified" "last" "min"]. -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters)) +- `aggregation` (String) The type of aggregation. Can be one of ["unspecified" "last" "min" "max" "avg" "sum"]. +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--metrics--filters)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.metrics.filters` Required: - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--metrics--filters--operator)) Optional: - `label` (String) Label associated with the metric. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.label` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.metrics.filters.operator` Required: @@ -2083,25 +1481,25 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans` Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans--filters)) - `lucene_query` (String) -- `spans_aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--spans_aggregation)) +- `spans_aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans--spans_aggregation)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans.filters` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--thresholds--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans.filters.field` Required: @@ -2109,8 +1507,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans.filters.operator` Required: @@ -2122,20 +1520,20 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds.spans.spans_aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query.spans.spans_aggregation` Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.thresholds` + +### Nested Schema for `layout.sections.rows.widgets.definition.gauge.thresholds` Optional: @@ -2144,8 +1542,8 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart` Optional: @@ -2155,40 +1553,40 @@ Optional: - `display_on_bar` (Boolean) - `group_name_template` (String) - `max_bars_per_chart` (Number) -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--query)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query)) - `scale_type` (String) - `sort_by` (String) -- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--stack_definition)) -- `unit` (String) The unit of the chart. Can be one of kbytes, mibytes, seconds, mbytes, kibytes, gibytes, usd, unspecified, bytes, euro, microseconds, milliseconds, gbytes, bytes_iec, euro_cents, usd_cents. +- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--stack_definition)) +- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. - `y_axis_view_by` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query` Optional: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs` Required: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--aggregation)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--aggregation)) Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--filters)) - `group_names` (List of String) -- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--group_names_fields)) +- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--group_names_fields)) - `lucene_query` (String) - `stacked_group_name` (String) -- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--stacked_group_name_field)) +- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--stacked_group_name_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.aggregation` Required: @@ -2197,11 +1595,11 @@ Required: Optional: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--aggregation--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.aggregation.percent` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.aggregation.observation_field` Required: @@ -2210,20 +1608,20 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.filters` Required: - `field` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--filters--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--filters--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--logs--filters--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.filters.operator` Required: @@ -2234,8 +1632,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.filters.observation_field` Required: @@ -2244,8 +1642,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.group_names_fields` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.group_names_fields` Required: @@ -2253,8 +1651,8 @@ Required: - `scope` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.stacked_group_name_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.logs.stacked_group_name_field` Required: @@ -2263,8 +1661,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.metrics` Required: @@ -2272,24 +1670,24 @@ Required: Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--metrics--filters)) - `group_names` (List of String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.metrics.filters` Required: - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--metrics--filters--operator)) Optional: - `label` (String) Label associated with the metric. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.filters.label` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.metrics.filters.operator` Required: @@ -2302,37 +1700,37 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans` Optional: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--filters)) -- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--group_names)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--filters)) +- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--group_names)) - `lucene_query` (String) -- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--stacked_group_name)) +- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--stacked_group_name)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.aggregation` Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.filters` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--y_axis_view_by--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.filters.field` Required: @@ -2340,8 +1738,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.filters.operator` Required: @@ -2353,8 +1751,8 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.group_names` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.group_names` Required: @@ -2362,8 +1760,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by.spans.stacked_group_name` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.query.spans.stacked_group_name` Required: @@ -2373,8 +1771,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.y_axis_view_by` + +### Nested Schema for `layout.sections.rows.widgets.definition.horizontal_bar_chart.stack_definition` Optional: @@ -2383,24 +1781,24 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart` Required: -- `query_definitions` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--query_definitions)) +- `query_definitions` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions)) Optional: -- `legend` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--legend)) -- `tooltip` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip)) +- `legend` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--legend)) +- `tooltip` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--tooltip)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions` Required: -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--query)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query)) Optional: @@ -2408,40 +1806,40 @@ Optional: - `data_mode_type` (String) - `is_visible` (Boolean) - `name` (String) -- `resolution` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--resolution)) -- `scale_type` (String) The scale type. Valid values are: linear, logarithmic, unspecified. +- `resolution` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--resolution)) +- `scale_type` (String) The scale type. Valid values are: unspecified, linear, logarithmic. - `series_count_limit` (Number) - `series_name_template` (String) -- `unit` (String) The unit. Valid values are: unspecified, milliseconds, seconds, kbytes, mbytes, gbytes, mibytes, gibytes, usd_cents, bytes_iec, euro, microseconds, bytes, kibytes, euro_cents, usd. +- `unit` (String) The unit. Valid values are: unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. Read-Only: - `id` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query` Optional: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.logs` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs` Required: -- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--logs--aggregations)) +- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--aggregations)) Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--logs--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--filters)) - `group_by` (List of String) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.logs.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.aggregations` Required: @@ -2450,11 +1848,11 @@ Required: Optional: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--logs--lucene_query--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--aggregations--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.logs.lucene_query.percent` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.aggregations.observation_field` Required: @@ -2463,20 +1861,20 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.logs.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.filters` Required: - `field` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--logs--lucene_query--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--filters--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--logs--lucene_query--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--logs--filters--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.logs.lucene_query.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.filters.operator` Required: @@ -2487,8 +1885,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.logs.lucene_query.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.logs.filters.observation_field` Required: @@ -2498,8 +1896,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.metrics` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.metrics` Required: @@ -2507,22 +1905,22 @@ Required: Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--metrics--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--metrics--filters)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.metrics.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.metrics.filters` Required: - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--metrics--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--metrics--filters--operator)) Optional: - `label` (String) Label associated with the metric. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.metrics.filters.label` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.metrics.filters.operator` Required: @@ -2535,36 +1933,36 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans` Optional: -- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--spans--aggregations)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--spans--filters)) -- `group_by` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--spans--group_by)) +- `aggregations` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--aggregations)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--filters)) +- `group_by` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--group_by)) - `lucene_query` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.spans.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.aggregations` Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.spans.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.filters` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--spans--lucene_query--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--tooltip--id--spans--lucene_query--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--line_chart--query_definitions--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.spans.lucene_query.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.filters.field` Required: @@ -2572,8 +1970,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.spans.lucene_query.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.filters.operator` Required: @@ -2585,8 +1983,8 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id.spans.lucene_query` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query.spans.group_by` Required: @@ -2596,8 +1994,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip.id` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.resolution` Optional: @@ -2606,18 +2004,19 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.legend` Optional: -- `columns` (List of String) The columns to display in the legend. Valid values are: unspecified, min, max, sum, avg, last. +- `columns` (List of String) The columns to display in the legend. Valid values are: last, unspecified, min, max, sum, avg. - `group_by_query` (Boolean) - `is_visible` (Boolean) Whether to display the legend. False by default. +- `placement` (String) The placement of the legend. Valid values are: hidden, unspecified, auto, bottom, side. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.tooltip` + +### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.tooltip` Optional: @@ -2626,8 +2025,8 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart` + +### Nested Schema for `layout.sections.rows.widgets.definition.markdown` Optional: @@ -2635,13 +2034,13 @@ Optional: - `tooltip_text` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart` Required: -- `label_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--label_definition)) -- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--query)) +- `label_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--label_definition)) +- `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query)) Optional: @@ -2651,11 +2050,11 @@ Optional: - `max_slices_per_chart` (Number) - `min_slice_percentage` (Number) - `show_legend` (Boolean) -- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--stack_definition)) +- `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--stack_definition)) - `unit` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.label_definition` Optional: @@ -2666,18 +2065,18 @@ Optional: - `show_value` (Boolean) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query` Optional: -- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--data_prime)) -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans)) +- `data_prime` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime` Required: @@ -2685,33 +2084,33 @@ Required: Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters)) - `group_names` (List of String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters` Optional: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--spans)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.logs` Required: - `field` (String) Field in the logs to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--logs--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--spans--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--logs--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.spans.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.logs.operator` Required: @@ -2722,8 +2121,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.spans.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.logs.observation_field` Required: @@ -2732,17 +2131,17 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.metrics` Required: - `label` (String) - `metric_name` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--spans--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--metrics--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.metrics.operator` Required: @@ -2754,16 +2153,16 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.spans` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--spans--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--spans--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--spans--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--data_prime--filters--spans--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.spans.field` Required: @@ -2771,8 +2170,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.spans.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.data_prime.filters.spans.operator` Required: @@ -2786,24 +2185,24 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs` Required: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--aggregation)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--aggregation)) Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--filters)) - `group_names` (List of String) -- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--group_names_fields)) +- `group_names_fields` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--group_names_fields)) - `lucene_query` (String) - `stacked_group_name` (String) -- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--stacked_group_name_field)) +- `stacked_group_name_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--stacked_group_name_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.aggregation` Required: @@ -2812,11 +2211,11 @@ Required: Optional: - `field` (String) -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--aggregation--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--aggregation--observation_field)) - `percent` (Number) The percentage of the aggregation to return. required when type is `percentile`. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.aggregation.percent` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.aggregation.observation_field` Required: @@ -2825,20 +2224,20 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.filters` Required: - `field` (String) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--filters--operator)) Optional: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--logs--filters--observation_field)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.filters.operator` Required: @@ -2849,8 +2248,8 @@ Optional: - `selected_values` (List of String) the values to filter by. When the type is `equals`, this field is optional, the filter will match only the selected values, and all the values if not set. When the type is `not_equals`, this field is required, and the filter will match spans without the selected values. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.observation_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.filters.observation_field` Required: @@ -2859,8 +2258,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.group_names_fields` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.group_names_fields` Required: @@ -2868,8 +2267,8 @@ Required: - `scope` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.stacked_group_name_field` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.logs.stacked_group_name_field` Required: @@ -2878,8 +2277,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.metrics` Required: @@ -2887,24 +2286,24 @@ Required: Optional: -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--metrics--filters)) - `group_names` (List of String) - `stacked_group_name` (String) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.metrics.filters` Required: - `metric` (String) Metric name to apply the filter on. -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--operator)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--metrics--filters--operator)) Optional: - `label` (String) Label associated with the metric. - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.label` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.metrics.filters.operator` Required: @@ -2917,37 +2316,37 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans` Optional: -- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--aggregation)) -- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters)) -- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--group_names)) +- `aggregation` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--aggregation)) +- `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--filters)) +- `group_names` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--group_names)) - `lucene_query` (String) -- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--stacked_group_name)) +- `stacked_group_name` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--stacked_group_name)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.aggregation` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.aggregation` Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99" "percentile_95"]. When the aggregation type is `dimension`, can be one of ["unique_count" "error_count" "unspecified"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.filters` Required: -- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--field)) -- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--id--definition--pie_chart--unit--spans--filters--operator)) +- `field` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--filters--field)) +- `operator` (Attributes) Operator to use for filtering. (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--pie_chart--query--spans--filters--operator)) - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.filters.field` Required: @@ -2955,8 +2354,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.filters.operator` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.filters.operator` Required: @@ -2968,8 +2367,8 @@ Optional: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.group_names` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.group_names` Required: @@ -2977,8 +2376,8 @@ Required: - `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit.spans.stacked_group_name` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.query.spans.stacked_group_name` Required: @@ -2988,8 +2387,8 @@ Required: - -### Nested Schema for `layout.sections.rows.id.definition.pie_chart.unit` + +### Nested Schema for `layout.sections.rows.widgets.definition.pie_chart.stack_definition` Optional: @@ -3094,39 +2493,39 @@ Optional: - `value_display_options` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options)) -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options` +### Nested Schema for `variables.definition.multi_select.source.query.query` Optional: -- `logs` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--logs)) -- `metrics` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--metrics)) -- `spans` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans)) +- `logs` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--logs)) +- `metrics` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics)) +- `spans` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--spans)) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans` + +### Nested Schema for `variables.definition.multi_select.source.query.query.logs` Optional: -- `field_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--field_name)) -- `field_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--field_value)) +- `field_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--logs--field_name)) +- `field_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--logs--field_value)) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.field_value` + +### Nested Schema for `variables.definition.multi_select.source.query.query.logs.field_name` Required: - `log_regex` (String) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.field_value` + +### Nested Schema for `variables.definition.multi_select.source.query.query.logs.field_value` Required: -- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--field_value--observation_field)) +- `observation_field` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--logs--field_value--observation_field)) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.field_value.observation_field` + +### Nested Schema for `variables.definition.multi_select.source.query.query.logs.field_value.observation_field` Required: @@ -3136,43 +2535,43 @@ Required: - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics` Optional: -- `label_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--label_name)) -- `label_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--label_value)) -- `metric_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--metric_name)) +- `label_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_name)) +- `label_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value)) +- `metric_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--metric_name)) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_name` Required: - `metric_regex` (String) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value` Optional: -- `label_filters` (Attributes List) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--metric_name--label_filters)) -- `label_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--metric_name--label_name)) -- `metric_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--metric_name--metric_name)) +- `label_filters` (Attributes List) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters)) +- `label_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_name)) +- `metric_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--metric_name)) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name.label_filters` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters` Optional: -- `label` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--metric_name--label_filters--label)) -- `metric` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--metric_name--label_filters--metric)) -- `operator` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--metric_name--label_filters--operator)) +- `label` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters--label)) +- `metric` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters--metric)) +- `operator` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters--operator)) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name.label_filters.operator` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters.label` Optional: @@ -3180,8 +2579,8 @@ Optional: - `variable_name` (String) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name.label_filters.operator` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters.metric` Optional: @@ -3189,8 +2588,8 @@ Optional: - `variable_name` (String) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name.label_filters.operator` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters.operator` Required: @@ -3198,10 +2597,10 @@ Required: Optional: -- `selected_values` (Attributes List) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--metric_name--label_filters--operator--selected_values)) +- `selected_values` (Attributes List) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--metrics--label_value--label_filters--operator--selected_values)) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name.label_filters.operator.selected_values` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_filters.operator.selected_values` Optional: @@ -3211,8 +2610,8 @@ Optional: - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name.label_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.label_name` Optional: @@ -3220,8 +2619,8 @@ Optional: - `variable_name` (String) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name.metric_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.label_value.metric_name` Optional: @@ -3230,8 +2629,8 @@ Optional: - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.metric_name` + +### Nested Schema for `variables.definition.multi_select.source.query.query.metrics.metric_name` Required: @@ -3239,24 +2638,24 @@ Required: - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans` + +### Nested Schema for `variables.definition.multi_select.source.query.query.spans` Optional: -- `field_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--field_name)) -- `field_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--value_display_options--spans--field_value)) +- `field_name` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--spans--field_name)) +- `field_value` (Attributes) (see [below for nested schema](#nestedatt--variables--definition--multi_select--source--query--query--spans--field_value)) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.field_value` + +### Nested Schema for `variables.definition.multi_select.source.query.query.spans.field_name` Required: - `span_regex` (String) - -### Nested Schema for `variables.definition.multi_select.source.query.value_display_options.spans.field_value` + +### Nested Schema for `variables.definition.multi_select.source.query.query.spans.field_value` Required: diff --git a/docs/resources/dashboards_folder.md b/docs/resources/dashboards_folder.md index 618f84e4..7ddd53dc 100644 --- a/docs/resources/dashboards_folder.md +++ b/docs/resources/dashboards_folder.md @@ -8,18 +8,7 @@ description: |- # coralogix_dashboards_folder (Resource) -## Example Usage -```hcl -resource "coralogix_dashboards_folder" "example" { - name = "example" -} - -resource "coralogix_dashboards_folder" "example_2" { - name = "example2" - parent_id = coralogix_dashboards_folder.example.id -} -``` @@ -34,20 +23,3 @@ resource "coralogix_dashboards_folder" "example_2" { ### Read-Only - `id` (String) Unique identifier for the folder. - -### Import - -Dashboards folders can be imported using the `id`, e.g. - -```shell -$ terraform import coralogix_dashboards_folder.this -``` - -to get the folder id run the following command and look for the id field of the folder you want to import: -```sh -grpcurl -H "Authorization: Bearer " -d @ ng-api-grpc.:443 com.coralogixapis.dashboards.v1.services.DashboardFoldersService/ListDashboardFolders < ## Schema @@ -77,19 +56,3 @@ Optional: Read-Only: - `modification_time_uploaded` (String) - -### Import -```sh -terraform import coralogix_data_set.example -``` -(please note that id should be a string, that is, surrounded by quotation marks) - -to get the data_set id run the following command and look for the id of the data_set you want to import: -```sh -grpcurl -H "Authorization: Bearer " -d @ ng-api-grpc.:443 com.coralogix.enrichment.v1.CustomEnrichmentService/GetCustomEnrichments < @@ -83,7 +44,7 @@ Required: Read-Only: -- `id` (Number) The ID of this resource. +- `id` (Number) @@ -107,7 +68,7 @@ Required: Read-Only: -- `id` (Number) The ID of this resource. +- `id` (Number) @@ -127,7 +88,7 @@ Required: Read-Only: -- `id` (Number) The ID of this resource. +- `id` (Number) @@ -147,7 +108,7 @@ Required: Read-Only: -- `id` (Number) The ID of this resource. +- `id` (Number) @@ -160,9 +121,3 @@ Optional: - `delete` (String) - `read` (String) - `update` (String) - -### Import -```sh -terraform import coralogix_enrichment.example -``` -enrichment-type can be one of ["geo_ip" "suspicious_ip" "custom"] diff --git a/docs/resources/events2metric.md b/docs/resources/events2metric.md index 5e056461..8f47bbeb 100644 --- a/docs/resources/events2metric.md +++ b/docs/resources/events2metric.md @@ -2,100 +2,16 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_events2metric Resource - terraform-provider-coralogix" subcategory: "" -description: "Coralogix events2metric. More info:-https://coralogix.com/docs/event2metrics/" +description: |- --- # coralogix_events2metric (Resource) -## Example Usage of events2metric with logs_query option - -```hcl -resource "coralogix_events2metric" "logs2metric" { - name = "logs2metricExample" - description = "logs2metric from coralogix terraform provider" - logs_query = { - lucene = "remote_addr_enriched:/.*/" - applications = ["filter:startsWith:nginx"] //change here for existing applications from your account - severities = ["Debug"] - } - - metric_fields = { - method = { - source_field = "method" - }, - geo_point = { - source_field = "remote_addr_geoip.location_geopoint" - aggregations = { - max = { - enable = false - } - min = { - enable = false - } - avg = { - enable = true - } - } - } - } - - metric_labels = { - Status = "status" - Path = "http_referer" - } - - permutations = { - limit = 20000 - } -} -``` - - -## Example Usage of events2metric with spans_query option - -```hcl -resource "coralogix_events2metric" "spans2metric" { - name = "spans2metricExample" - description = "spans2metric from coralogix terraform provider" - - spans_query = { - lucene = "remote_addr_enriched:/.*/" - applications = ["filter:startsWith:nginx"] //change here for existing applications from your account - actions = ["action-name"] - services = ["service-name"] - } - - metric_fields = { - method = { - source_field = "method" - }, - geo_point = { - source_field = "remote_addr_geoip.location_geopoint" - aggregations = { - max = { - enable = false - } - min = { - enable = false - } - avg = { - enable = true - } - } - } - } - - metric_labels = { - Status = "status" - Path = "http_referer" - } - - permutations = { - limit = 20000 - } -} -``` + + + + ## Schema @@ -123,7 +39,7 @@ Optional: - `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `lucene` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of severities that we interested in. Can be one of ["Info" "Warning" "Error" "Critical" "Unspecified" "Debug" "Verbose"] +- `severities` (Set of String) An array of severities that we interested in. Can be one of ["Unspecified" "Debug" "Verbose" "Info" "Warning" "Error" "Critical"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx @@ -267,20 +183,3 @@ Optional: - `lucene` (String) The search_query that we wanted to be notified on. - `services` (Set of String) An array that contains log’s services names that we want to be notified on. Services can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - - -## Import - -```sh -terraform import coralogix_events2metric.example -``` - -to get the events2metric id run the following command and look for the id of the events2metric you want to import: -```sh -grpcurl -H "Authorization: Bearer " -d @ ng-api-grpc.:443 com.coralogix.enrichment.v1.CustomEnrichmentService/GetCustomEnrichments < ## Schema @@ -41,19 +29,3 @@ resource "coralogix_grafana_folder" "test_folder" { - `id` (String) The ID of this resource. - `url` (String) The full URL of the folder. - - -## Import - -```sh -terraform import coralogix_grafana_folder.example -``` - -to get the grafana_folder id/uid run the following command and look for the id/uid of the grafana_folder you want to import: -```sh -curl --location --request GET 'https://ng-api-http.:443/grafana/api/folders' \ ---header 'Authorization: Bearer ' \ ---data-raw '' -``` - -[region-domain table](../index.md#region-domain-table) \ No newline at end of file diff --git a/docs/resources/group.md b/docs/resources/group.md index ed6c7dcc..cdf6cc78 100644 --- a/docs/resources/group.md +++ b/docs/resources/group.md @@ -11,42 +11,6 @@ description: |- Coralogix group. -## Example Usage - -```hcl -resource "coralogix_custom_role" "example" { - name = "Example custom role" - description = "This role is created with terraform!" - parent_role = "Standard User" - permissions = ["spans.events2metrics:UpdateConfig"] -} - -resource "coralogix_user" "example" { - user_name = "example@coralogix.com" - name = { - given_name = "example" - family_name = "example" - } -} - -resource "coralogix_scope" "example" { - display_name = "ExampleScope" - default_expression = "true" - filters = [ - { - entity_type = "logs" - expression = "(subsystemName == 'purchases') || (subsystemName == 'signups')" - } - ] -} - -resource "coralogix_group" "example" { - display_name = "example" - role = coralogix_custom_role.example.name - members = [coralogix_user.example.id] - scope_id = data.coralogix_scope.example.id -} -``` ## Schema @@ -64,16 +28,3 @@ resource "coralogix_group" "example" { ### Read-Only - `id` (String) Group ID. - -### Import - -```sh -terraform import coralogix_group.example -``` - -to get the group id you can use the following command: -```sh -curl --location --request GET 'https://ng-api-http./scim/Groups' \ ---header 'Authorization: Bearer ' \' -``` -[region-domain table](../index.md#region-domain-table) diff --git a/docs/resources/hosted_dashboard.md b/docs/resources/hosted_dashboard.md index d271e309..d54aeea1 100644 --- a/docs/resources/hosted_dashboard.md +++ b/docs/resources/hosted_dashboard.md @@ -2,35 +2,15 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_hosted_dashboard Resource - terraform-provider-coralogix" subcategory: "" -description: "Hosted dashboard. Can be one of - ["grafana"]." +description: |- + Hosted dashboard. Can be one of - ["grafana"]. --- # coralogix_hosted_dashboard (Resource) -Hosted dashboard. -Can be one of - ["grafana"]. -## Example Usage - -```hcl -resource "coralogix_hosted_dashboard" dashboard { - grafana { - config_json = file("./grafana_dashboard.json") - } -} -``` - -```hcl -resource "coralogix_hosted_dashboard" dashboard { - grafana { - config_json = file("./grafana_dashboard.json") - folder = coralogix_grafana_folder.test_folder.id - } -} - -resource "coralogix_grafana_folder" "test_folder" { - title = "Terraform Test Folder" -} -``` +Hosted dashboard. Can be one of - ["grafana"]. + + ## Schema diff --git a/docs/resources/integration.md b/docs/resources/integration.md index faabc48c..a153df45 100644 --- a/docs/resources/integration.md +++ b/docs/resources/integration.md @@ -12,26 +12,6 @@ A Coralogix Integration -## Example Usage - -```hcl -resource "coralogix_integration" "example" { - integration_key = "aws-metrics-collector" - version = "0.1.0" - # Note that the attribute casing is important here - parameters = { - ApplicationName = "cxsdk" - SubsystemName = "aws-metrics-collector" - MetricNamespaces = ["AWS/S3"] - AwsRoleArn = "arn:aws:iam::123456789012:role/example-role" - IntegrationName = "sdk-integration-setup" - AwsRegion = "eu-north-1" - WithAggregations = false - EnrichWithTags = true - } -} -``` - ## Schema diff --git a/docs/resources/recording_rules_groups_set.md b/docs/resources/recording_rules_groups_set.md index 8f791a99..600a0ec0 100644 --- a/docs/resources/recording_rules_groups_set.md +++ b/docs/resources/recording_rules_groups_set.md @@ -2,58 +2,16 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_recording_rules_groups_set Resource - terraform-provider-coralogix" subcategory: "" -description: "Coralogix recording-rules-groups-set. For more information - https://coralogix.com/docs/recording-rules/." +description: |- + --- # coralogix_recording_rules_groups_set (Resource) -## Example Usage - -### Import from yaml file -```hcl -resource "coralogix_recording_rules_groups_set" recording_rules_group { - yaml_content = file("./rule-group-set.yaml") -} -``` - -### Explicitly -```hcl -resource "coralogix_recording_rules_groups_set" recording_rules_groups_set_explicit { - name = "Name" - groups = [ - { - name = "Foo" - interval = 180 - limit = 100 - rules = [ - { - record = "ts3db_live_ingester_write_latency:3m" - expr = "sum(rate(ts3db_live_ingester_write_latency_seconds_count{CX_LEVEL=\"staging\",pod=~\"ts3db-live-ingester.*\"}[2m])) by (pod)" - }, - { - record = "job:http_requests_total:sum" - expr = "sum(rate(http_requests_total[5m])) by (job)" - }, - ] - }, - { - name = "Bar" - interval = 180 - limit = 100 - rules = [ - { - record = "ts3db_live_ingester_write_latency:3m" - expr = "sum(rate(ts3db_live_ingester_write_latency_seconds_count{CX_LEVEL=\"staging\",pod=~\"ts3db-live-ingester.*\"}[2m])) by (pod)" - }, - { - record = "job:http_requests_total:sum" - expr = "sum(rate(http_requests_total[5m])) by (job)" - }, - ] - }, - ] -} -``` + + + + ## Schema @@ -91,17 +49,3 @@ Required: Optional: - `labels` (Map of String) Labels to add or overwrite before storing the result. - -## Import - -```sh -terraform import coralogix_recording_rules_groups_set.example -``` - -To get the recording-rules-groups-set id run the following command and look for the id field of the recording-rules-groups-set you want to import: -```sh -grpcurl -H "Authorization: Bearer " -d @ ng-api-grpc.:443 rule_manager.groups.RuleGroupSets/List <[A-z]+)\\s[\\/\\\\]+(?P[^\\s]+)\\s*(?P[A-z0-9\\/\\.]+)\\\\\\\"\\s*(?P\\d+)\\s*(?P\\d+)?\\s*?\\\\\\\"(?P[^\"]+)\\\"\\s*\\\\\\\"(?P[^\"]+)\\\"\\s(?P\\d{1,6})\\s*(?P\\d{1,6})" - } - } - - rules { - parse { - name = "HttpRequestParser2" - description = "Parse the fields of the HTTP request - will be applied after HttpRequestParser1" - source_field = "text" - destination_field = "text" - regular_expression = "(?P\\d{1,3}.\\d{1,3}.\\d{1,3}.\\d{1,3})\\s*-\\s*(?P[^ ]+)\\s*\\[(?P\\d{4}-\\d{2}\\-\\d{2}T\\d{2}\\:\\d{2}\\:\\d{2}\\.\\d{1,6}Z)\\]\\s*\\\\\\\"(?P[A-z]+)\\s[\\/\\\\]+(?P[^\\s]+)\\s*(?P[A-z0-9\\/\\.]+)\\\\\\\"\\s*(?P\\d+)\\s*(?P\\d+)?\\s*?\\\\\\\"(?P[^\"]+)\\\"\\s*\\\\\\\"(?P[^\"]+)\\\"\\s(?P\\d{1,6})\\s*(?P\\d{1,6})" - } - } - - rules { - json_stringify { - name = "json_stringify rule" - source_field = "text" - destination_field = "text" - keep_source_field = "false" - #for better example look at - https://coralogix.com/docs/log-parsing-rules/#stringify-json-fields - } - } - } -} -``` - -The above example wil create the following rule-group: -![img.png](rules_group-example.png) -rule_group which contains 2 rule_subgroups, the first rule_subgroups contains 4 rules and the second rule_subgroups contains 3 rules. -On every rule_group there are rule_subgroups with 'and' (&&) operation between them and on every rule_subgroups there are rules with 'or' (||) operation between them. -### Extract Rule - -```hcl -extract { - name = "Severity Rule" - description = "Look for default severity text" - source_field = "text" - regular_expression = "message\\s*:s*(?P\\d+)\\s*.*?status\\sis\\s(?P\\[^\"]+)" -} -``` - -### Json-Extract Rule - -```hcl -json_extract { - name = "Worker to category" - description = "Extracts value from 'worker' and populates 'Category'" - json_key = "worker" - destination_field = "Category" -} -``` - -### Replace Rule - -```hcl -replace { - name = "Delete prefix" - description = "Deletes data before Json" - source_field = "text" - destination_field = "text" - replacement_string = "{" - regular_expression = ".*{" -} -``` - -### Block Rule - -```hcl -block { - name = "Block 28000" - description = "Block 2800 pg error" - source_field = "text" - regular_expression = "sql_error_code\\s*=\\s*28000" -} -``` - -### Parse Rule - -```hcl -parse { - name = "HttpRequestParser1" - description = "Parse the fields of the HTTP request" - source_field = "text" - destination_field = "text" - regular_expression = "(?P\\d{1,3}.\\d{1,3}.\\d{1,3}.\\d{1,3})\\s*-\\s*(?P[^ ]+)\\s*\\[(?P\\d{4}-\\d{2}\\-\\d{2}T\\d{2}\\:\\d{2}\\:\\d{2}\\.\\d{1,6}Z)\\]\\s*\\\\\\\"(?P[A-z]+)\\s[\\/\\\\]+(?P[^\\s]+)\\s*(?P[A-z0-9\\/\\.]+)\\\\\\\"\\s*(?P\\d+)\\s*(?P\\d+)?\\s*?\\\\\\\"(?P[^\"]+)\\\"\\s*\\\\\\\"(?P[^\"]+)\\\"\\s(?P\\d{1,6})\\s*(?P\\d{1,6})" -} -``` - -### Json-Stringify Rule - -```hcl -json_stringify { - name = "json_stringify rule" - source_field = "text" - destination_field = "text" - keep_source_field = "false" - #for better example look at - https://coralogix.com/docs/log-parsing-rules/#stringify-json-fields -} -``` - -### Extract-Timestamp Rule - -```hcl -extract_timestamp { - name = "example extract-timestamp rule from terraform" - description = "rule created by coralogix terraform provider" - source_field = "text" - field_format_standard = "Strftime" - time_format = "%Y-%m-%dT%H:%M:%S.%f%z" -} -``` - -### Remove-Fields Rule - -```hcl -remove_fields { - name = "Example remove-fields rule from terraform" - description = "rule created by coralogix terraform provider" - excluded_fields = ["coralogix.metadata.applicationName", "coralogix.metadata.className"] -} -``` - -### Parse-Json-Field Rule - -```hcl -parse_json_field { - name = "Example parse-json-field rule from terraform" - description = "rule created by coralogix terraform provider" - source_field = "text" - destination_field = "text" - keep_source_field = "true" - keep_destination_field = "true" -} -``` - ## Schema @@ -309,7 +114,7 @@ Read-Only: Required: -- `field_format_standard` (String) The format standard you want to use. Can be one of ["MilliTS" "MicroTS" "NanoTS" "Strftime" "JavaSDF" "Golang" "SecondTS"] +- `field_format_standard` (String) The format standard you want to use. Can be one of ["Strftime" "JavaSDF" "Golang" "SecondTS" "MilliTS" "MicroTS" "NanoTS"] - `name` (String) The rule name. - `source_field` (String) The field on which the Regex will operate on. Accepts lowercase only. - `time_format` (String) A time format that matches the field format standard @@ -330,7 +135,7 @@ Read-Only: Required: -- `destination_field` (String) The field that will be populated by the results of RegEx operation.Can be one of [Method ThreadID Severity Text Category Class]. +- `destination_field` (String) The field that will be populated by the results of RegEx operation.Can be one of [Class Method ThreadID Severity Text Category]. - `json_key` (String) JSON key to extract its value directly into a Coralogix metadata field. - `name` (String) The rule name. @@ -462,18 +267,3 @@ Optional: - `delete` (String) - `read` (String) - `update` (String) - -## Import - -```sh -terraform import coralogix_rules_group.example -``` - -to get the coralogix_rules_group id run the following command and look for the id of the coralogix_rules_group you want to import: -```sh -curl --location --request GET 'https://api./api/v1/external/rules' \ ---header 'Authorization: Bearer ' \ ---data-raw '' -``` - -[region-domain table](../index.md#region-domain-table) \ No newline at end of file diff --git a/docs/resources/scope.md b/docs/resources/scope.md index 28dbbbed..4bfd4eed 100644 --- a/docs/resources/scope.md +++ b/docs/resources/scope.md @@ -10,27 +10,14 @@ description: |- Coralogix Scope. -## Example Usage - -```hcl -resource "coralogix_scope" "example" { - display_name = "ExampleScope" - default_expression = "true" - filters = [ - { - entity_type = "logs" - expression = "(subsystemName == 'purchases') || (subsystemName == 'signups')" - } - ] -} -``` + ## Schema ### Required -- `default_expression` (String) Default expression to use when no filter matches the query. Until further notice, this can is limited to `true` (everything is included) or `false` (nothing is included). Use a version tag (e.g ` true` or ` false`) +- `default_expression` (String) Default expression to use when no filter matches the query. Until further notice, this can is limited to `true` (everything is included) or `false` (nothing is included). Use a version tag (e.g `true` or `false`) - `display_name` (String) Scope display name. - `filters` (Attributes List) Filters applied to include data in the scope. (see [below for nested schema](#nestedatt--filters)) diff --git a/docs/resources/slo.md b/docs/resources/slo.md index eeaa101e..e2c9f78f 100644 --- a/docs/resources/slo.md +++ b/docs/resources/slo.md @@ -1,61 +1,24 @@ --- - # generated by https://github.com/hashicorp/terraform-plugin-docs - page_title: "coralogix_slo Resource - terraform-provider-coralogix" subcategory: "" description: |- -Coralogix SLO. + Coralogix SLO. --- # coralogix_slo (Resource) -Use this resource to create, update, and delete Coralogix Service Level Objectives (SLOs). - -You need an API Key for **Alerts, Rules & Tags** to provision this resource. Use this key to set the `api_key` attribute in the `provider` block or implicitly via environment variables: `CORALOGIX_API_KEY` or `CORALOGIX_ENV`. - -Note: Only Administrators can manage SLOs. - -## Example Usage - -```hcl -resource "coralogix_slo" "example" { - name = "coralogix_slo_example" - service_name = "service_name" - description = "description" - target_percentage = 30 - type = "error" - period = "7_days" -} - -resource "coralogix_slo" "example_2" { - name = "coralogix_slo_example" - service_name = "service_name" - description = "description" - target_percentage = 30 - type = "latency" - threshold_microseconds = 1000000 - threshold_symbol_type = "greater" - period = "7_days" - filters = [ - { - field = "severity" - compare_type = "is" - field_values = ["error", "warning"] - }, - ] -} -``` +Coralogix SLO. + - + ## Schema ### Required - `name` (String) SLO name. -- `period` (String) Period. This is the period of the SLO. Valid values - are: ["30_days" "unspecified" "7_days" "14_days"] +- `period` (String) Period. This is the period of the SLO. Valid values are: ["30_days" "unspecified" "7_days" "14_days"] - `service_name` (String) Service name. This is the name of the service that the SLO is associated with. - `target_percentage` (Number) Target percentage. This is the target percentage of the SLO. - `type` (String) Type. This is the type of the SLO. Valid values are: "error", "latency". @@ -65,7 +28,7 @@ resource "coralogix_slo" "example_2" { - `description` (String) Optional SLO description. - `filters` (Attributes Set) (see [below for nested schema](#nestedatt--filters)) - `threshold_microseconds` (Number) Threshold in microseconds. Required when `type` is `latency`. -- `threshold_symbol_type` (String) Threshold symbol type. Required when `type` is `latency`. Valid values are: ["greater" "greater_or_equal" "less" "less_or_equal" "equal"] +- `threshold_symbol_type` (String) Threshold symbol type. Required when `type` is `latency`. Valid values are: ["greater_or_equal" "less" "less_or_equal" "equal" "greater"] ### Read-Only @@ -74,13 +37,11 @@ resource "coralogix_slo" "example_2" { - `status` (String) - ### Nested Schema for `filters` Required: -- `compare_type` (String) Compare type. This is the compare type of the SLO. Valid values - are: ["starts_with" "ends_with" "includes" "unspecified" "is"] +- `compare_type` (String) Compare type. This is the compare type of the SLO. Valid values are: ["unspecified" "is" "starts_with" "ends_with" "includes"] - `field` (String) Optional: diff --git a/docs/resources/tco_policies_logs.md b/docs/resources/tco_policies_logs.md index 7e001249..ee6d459d 100644 --- a/docs/resources/tco_policies_logs.md +++ b/docs/resources/tco_policies_logs.md @@ -1,64 +1,29 @@ --- - # generated by https://github.com/hashicorp/terraform-plugin-docs - page_title: "coralogix_tco_policies_logs Resource - terraform-provider-coralogix" subcategory: "" -description: "Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. +description: |- + Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. --- # coralogix_tco_policies_logs (Resource) Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. -**Please note!** - This resource will override all the existing policies with the new ones (even those who were managed outside terraform). - -## Example Usage - -```hcl -resource "coralogix_tco_policies_logs" "tco_policies" { - policies = [ - { - name = "Example tco_policy from terraform 1" - priority = "low" - severities = ["debug", "verbose", "info"] - applications = { - rule_type = "starts_with" - names = ["prod"] - } - subsystems = { - rule_type = "is" - names = ["mobile", "web"] - } - archive_retention_id = "e1c980d0-c910-4c54-8326-67f3cf95645a" - }, - { - name = "Example tco_policy from terraform 2" - priority = "medium" - severities = ["error", "warning", "critical"] - applications = { - rule_type = "starts_with" - names = ["prod"] - } - subsystems = { - rule_type = "is" - names = ["mobile", "web"] - } - } - ] -} -``` - + ## Schema ### Required - `policies` (Attributes List) (see [below for nested schema](#nestedatt--policies)) - +### Read-Only + +- `id` (String) This field can be ignored + ### Nested Schema for `policies` Required: @@ -68,15 +33,12 @@ Required: Optional: -- `applications` (Attributes) The applications to apply the policy on. Applies the policy on all the applications by - default. (see [below for nested schema](#nestedatt--policies--applications)) +- `applications` (Attributes) The applications to apply the policy on. Applies the policy on all the applications by default. (see [below for nested schema](#nestedatt--policies--applications)) - `archive_retention_id` (String) Allowing logs with a specific retention to be tagged. - `description` (String) The policy description - `enabled` (Boolean) Determines weather the policy will be enabled. True by default. -- `severities` (Set of String) The severities to apply the policy on. Can be few - of ["verbose" "info" "warning" "error" "critical" "debug"]. -- `subsystems` (Attributes) The subsystems to apply the policy on. Applies the policy on all the subsystems by - default. (see [below for nested schema](#nestedatt--policies--subsystems)) +- `severities` (Set of String) The severities to apply the policy on. Can be few of ["critical" "debug" "verbose" "info" "warning" "error"]. +- `subsystems` (Attributes) The subsystems to apply the policy on. Applies the policy on all the subsystems by default. (see [below for nested schema](#nestedatt--policies--subsystems)) Read-Only: @@ -84,7 +46,6 @@ Read-Only: - `order` (Number) The policy's order between the other policies. - ### Nested Schema for `policies.applications` Required: @@ -93,10 +54,10 @@ Required: Optional: -- `rule_type` (String) The rule type. Can be one of ["includes" "is" "is_not" "starts_with"]. +- `rule_type` (String) The rule type. Can be one of ["is" "is_not" "starts_with" "includes"]. - + ### Nested Schema for `policies.subsystems` Required: @@ -106,11 +67,3 @@ Required: Optional: - `rule_type` (String) - -## Import - -```sh -terraform import coralogix_tco_policies_logs.example "" -``` - -terraform will import all the policies from the Coralogix TCO-Policies-List. \ No newline at end of file diff --git a/docs/resources/tco_policies_traces.md b/docs/resources/tco_policies_traces.md index a063e56e..0bfc343b 100644 --- a/docs/resources/tco_policies_traces.md +++ b/docs/resources/tco_policies_traces.md @@ -12,67 +12,6 @@ Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/t -## Example Usage - -```hcl -resource "coralogix_tco_policies_traces" "tco_policies" { - policies = [ - { - name = "Example tco_policy from terraform 1" - priority = "low" - applications = { - rule_type = "starts_with" - names = ["prod"] - } - subsystems = { - rule_type = "is" - names = ["mobile", "web"] - } - actions = { - rule_type = "is_not" - names = ["action-name", "action-name2"] - } - services = { - rule_type = "is" - names = ["service-name", "service-name2"] - } - tags = { - "tags.http.method" = { - rule_type = "includes" - names = ["GET"] - } - } - archive_retention_id = "e1c980d0-c910-4c54-8326-67f3cf95645a" - }, - { - name = "Example tco_policy from terraform 2" - priority = "medium" - applications = { - rule_type = "starts_with" - names = ["staging"] - } - subsystems = { - rule_type = "is_not" - names = ["mobile", "web"] - } - actions = { - names = ["action-name", "action-name2"] - } - services = { - names = ["service-name", "service-name2"] - } - tags = { - "tags.http.method" = { - rule_type = "is_not" - names = ["GET", "POST"] - } - } - }, - ] -} -``` - - ## Schema @@ -166,11 +105,3 @@ Required: Optional: - `rule_type` (String) - -## Import - -```sh -terraform import coralogix_tco_policies_traces.example "" -``` - -terraform will import all the policies from the Coralogix TCO-Policies-List. \ No newline at end of file diff --git a/docs/resources/team.md b/docs/resources/team.md index fc8d8206..8110b640 100644 --- a/docs/resources/team.md +++ b/docs/resources/team.md @@ -10,14 +10,6 @@ description: |- Coralogix Team. -## Example Usage - -```hcl -resource "coralogix_team" "example" { - name = "example" - daily_quota = 0.01 -} -``` diff --git a/docs/resources/user.md b/docs/resources/user.md index 44969ef9..91d02515 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -10,17 +10,7 @@ description: |- Coralogix User. -## Example Usage - -```hcl -resource "coralogix_user" "example" { - user_name = "user-name" - name { - family_name = "family-name" - given_name = "given-name" - } -} -``` + ## Schema @@ -57,18 +47,3 @@ Read-Only: - `primary` (Boolean) - `type` (String) - `value` (String) - -### Import - -```sh -terraform import coralogix_user.example -``` - -to get the user id you can use the following command: -```sh -curl --location --request GET 'https://ng-api-http./scim/Users' \ ---header 'Authorization: Bearer ' \' -``` -[region-domain table](../index.md#region-domain-table) - - diff --git a/docs/resources/webhook.md b/docs/resources/webhook.md index a2bbefa6..8d6bb17f 100644 --- a/docs/resources/webhook.md +++ b/docs/resources/webhook.md @@ -2,55 +2,14 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_webhook Resource - terraform-provider-coralogix" subcategory: "" -description: "Webhook defines integration. More info - https://coralogix.com/docs/alert-webhook-with-slack/." +description: |- + Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/. --- # coralogix_webhook (Resource) -Coralogix webhook. For more info please review -https://coralogix.com/docs/alert-webhook-with-slack/. - -## Example Usage -```hcl -resource "coralogix_webhook" "slack_webhook" { - name = "slack-webhook" - slack = { - notify_on = ["flow_anomalies"] - url = "https://join.slack.com/example" - } -} -``` - -## Example Usage of link webhook to alert. -### **please note that the linkage is done by the external_id (and not by the id)** -```hcl -resource "coralogix_webhook" "slack_webhook" { - name = "slack-webhook" - slack = { - notify_on = ["flow_anomalies"] - url = "https://join.slack.com/example" - } -} - -resource "coralogix_alert" "standard_alert" { - name = "Standard alert example" - description = "Example of standard alert from terraform" - severity = "Critical" - - notifications_group { - notification { - integration_id = coralogix_webhook.slack_webhook.external_id - retriggering_period_minutes = 60 - notify_on = "Triggered_only" - } - } - - standard { - search_query = "remote_addr_enriched:/.*/" - condition { - immediately = true - } - } -} -``` + +Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/. + @@ -82,7 +41,7 @@ resource "coralogix_alert" "standard_alert" { Optional: - `headers` (Map of String) Webhook headers. Map of string to string. -- `method` (String) Webhook method. can be one of: put, get, post +- `method` (String) Webhook method. can be one of: get, post, put - `payload` (String) Webhook payload. JSON string. - `url` (String) Webhook URL. - `uuid` (String) Webhook UUID. Computed automatically. @@ -197,26 +156,8 @@ Optional: Required: -- `type` (String) Slack attachment type. can be one of: empty, metric_snapshot, logs +- `type` (String) Slack attachment type. can be one of: logs, empty, metric_snapshot Optional: - `active` (Boolean) Determines if the attachment is active. Default is true. - -### Import - -```sh -terraform import coralogix_webhook.example -``` - -to get the alert id run the following command and look for the id field of the webhook you want to import: - -```sh -grpcurl -H "Authorization: Bearer " -d @ ng-api-grpc.:443 com.coralogix.outgoing_webhooks.v1.OutgoingWebhooksService/ListAllOutgoingWebhooks < Date: Fri, 8 Nov 2024 10:29:16 +0100 Subject: [PATCH 2/7] docs: moved around some docs --- examples/data-sources/.gitkeep | 0 .../coralogix_events2metric/data-source.tf | 3 + .../coralogix_hosted_dashboard/data-source.tf | 3 + .../coralogix_integration/data-source.tf | 4 + .../data-source.tf | 3 + .../coralogix_rules_group/data-source.tf | 3 + .../coralogix_scope/data-source.tf | 3 + .../data-source.tf | 3 + .../data-source.tf | 3 + .../coralogix_webhook/data-source.tf | 7 ++ examples/hosted_dashboard/main.tf | 28 ------- examples/provider/provider.tf | 11 ++- .../coralogix_events2metric/resource.tf | 79 +++++++++++++++++++ .../coralogix_group/resource.tf} | 15 ---- .../grafana_acc_dashboard.json | 0 .../grafana_acc_updated_dashboard.json | 0 .../grafana_dashboard.json | 0 .../coralogix_hosted_dashboard/resource.tf | 12 +++ .../coralogix_integration/resource.tf} | 18 ----- .../resource.tf} | 18 ----- .../rule-group-set.yaml | 0 .../coralogix_rules_group/resource.tf} | 4 - .../resources/coralogix_scope/resource.tf | 10 +++ .../coralogix_slo/resource.tf} | 14 ---- .../coralogix_tco_policies_logs/resource.tf} | 20 +---- .../resource.tf} | 18 ----- examples/resources/coralogix_team/resource.tf | 5 ++ .../coralogix_user/resource.tf} | 14 ---- .../coralogix_webhook/resource.tf} | 22 ------ examples/scope/main.tf | 28 ------- examples/team/main.tf | 19 ----- 31 files changed, 149 insertions(+), 218 deletions(-) delete mode 100644 examples/data-sources/.gitkeep create mode 100644 examples/data-sources/coralogix_events2metric/data-source.tf create mode 100644 examples/data-sources/coralogix_hosted_dashboard/data-source.tf create mode 100644 examples/data-sources/coralogix_integration/data-source.tf create mode 100644 examples/data-sources/coralogix_recording_rules_groups_set/data-source.tf create mode 100644 examples/data-sources/coralogix_rules_group/data-source.tf create mode 100644 examples/data-sources/coralogix_scope/data-source.tf create mode 100644 examples/data-sources/coralogix_tco_policies_logs/data-source.tf create mode 100644 examples/data-sources/coralogix_tco_policies_traces/data-source.tf create mode 100644 examples/data-sources/coralogix_webhook/data-source.tf delete mode 100644 examples/hosted_dashboard/main.tf create mode 100644 examples/resources/coralogix_events2metric/resource.tf rename examples/{group/main.tf => resources/coralogix_group/resource.tf} (65%) rename examples/{hosted_dashboard => resources/coralogix_hosted_dashboard}/grafana_acc_dashboard.json (100%) rename examples/{hosted_dashboard => resources/coralogix_hosted_dashboard}/grafana_acc_updated_dashboard.json (100%) rename examples/{hosted_dashboard => resources/coralogix_hosted_dashboard}/grafana_dashboard.json (100%) create mode 100644 examples/resources/coralogix_hosted_dashboard/resource.tf rename examples/{integration/main.tf => resources/coralogix_integration/resource.tf} (54%) rename examples/{recording_rules_groups_set/main.tf => resources/coralogix_recording_rules_groups_set/resource.tf} (70%) rename examples/{recording_rules_groups_set => resources/coralogix_recording_rules_groups_set}/rule-group-set.yaml (100%) rename examples/{rules_group/main.tf => resources/coralogix_rules_group/resource.tf} (98%) create mode 100644 examples/resources/coralogix_scope/resource.tf rename examples/{slo/main.tf => resources/coralogix_slo/resource.tf} (67%) rename examples/{tco_policies_logs/main.tf => resources/coralogix_tco_policies_logs/resource.tf} (76%) rename examples/{tco_policies_traces/main.tf => resources/coralogix_tco_policies_traces/resource.tf} (81%) create mode 100644 examples/resources/coralogix_team/resource.tf rename examples/{user/main.tf => resources/coralogix_user/resource.tf} (62%) rename examples/{webhook/main.tf => resources/coralogix_webhook/resource.tf} (83%) delete mode 100644 examples/scope/main.tf delete mode 100644 examples/team/main.tf diff --git a/examples/data-sources/.gitkeep b/examples/data-sources/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/examples/data-sources/coralogix_events2metric/data-source.tf b/examples/data-sources/coralogix_events2metric/data-source.tf new file mode 100644 index 00000000..9a7aa619 --- /dev/null +++ b/examples/data-sources/coralogix_events2metric/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_events2metric" "imported_logs2metric" { + id = coralogix_events2metric.logs2metric.id +} \ No newline at end of file diff --git a/examples/data-sources/coralogix_hosted_dashboard/data-source.tf b/examples/data-sources/coralogix_hosted_dashboard/data-source.tf new file mode 100644 index 00000000..29c168ac --- /dev/null +++ b/examples/data-sources/coralogix_hosted_dashboard/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_hosted_dashboard" imported_dashboard { + uid = coralogix_hosted_dashboard.dashboard.id +} diff --git a/examples/data-sources/coralogix_integration/data-source.tf b/examples/data-sources/coralogix_integration/data-source.tf new file mode 100644 index 00000000..eda538e5 --- /dev/null +++ b/examples/data-sources/coralogix_integration/data-source.tf @@ -0,0 +1,4 @@ + +data "coralogix_integration" "data_example" { + id = coralogix_integration.example.id +} \ No newline at end of file diff --git a/examples/data-sources/coralogix_recording_rules_groups_set/data-source.tf b/examples/data-sources/coralogix_recording_rules_groups_set/data-source.tf new file mode 100644 index 00000000..31bdc248 --- /dev/null +++ b/examples/data-sources/coralogix_recording_rules_groups_set/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_recording_rules_groups_set" "imported_recording_rules_groups_set" { + id = coralogix_recording_rules_groups_set.recording_rules_groups_set_explicit.id +} \ No newline at end of file diff --git a/examples/data-sources/coralogix_rules_group/data-source.tf b/examples/data-sources/coralogix_rules_group/data-source.tf new file mode 100644 index 00000000..290a86fe --- /dev/null +++ b/examples/data-sources/coralogix_rules_group/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_rules_group" "imported_rules_group_example" { + id = coralogix_rules_group.rules_group_example.id +} diff --git a/examples/data-sources/coralogix_scope/data-source.tf b/examples/data-sources/coralogix_scope/data-source.tf new file mode 100644 index 00000000..dbf6b2de --- /dev/null +++ b/examples/data-sources/coralogix_scope/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_scope" "data_example" { + id = coralogix_scope.example.id +} \ No newline at end of file diff --git a/examples/data-sources/coralogix_tco_policies_logs/data-source.tf b/examples/data-sources/coralogix_tco_policies_logs/data-source.tf new file mode 100644 index 00000000..e1abbac0 --- /dev/null +++ b/examples/data-sources/coralogix_tco_policies_logs/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_tco_policies_logs" "data_tco_policies" { + depends_on = [coralogix_tco_policies_logs.tco_policies] +} diff --git a/examples/data-sources/coralogix_tco_policies_traces/data-source.tf b/examples/data-sources/coralogix_tco_policies_traces/data-source.tf new file mode 100644 index 00000000..e2dd462f --- /dev/null +++ b/examples/data-sources/coralogix_tco_policies_traces/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_tco_policies_traces" "tco_policies_data" { + depends_on = [coralogix_tco_policies_traces.tco_policies] +} \ No newline at end of file diff --git a/examples/data-sources/coralogix_webhook/data-source.tf b/examples/data-sources/coralogix_webhook/data-source.tf new file mode 100644 index 00000000..e799dbbd --- /dev/null +++ b/examples/data-sources/coralogix_webhook/data-source.tf @@ -0,0 +1,7 @@ +data "coralogix_webhook" "imported_webhook_by_id" { + id = coralogix_webhook.slack_webhook.id +} + +data "coralogix_webhook" "imported_webhook_by_name" { + name = coralogix_webhook.slack_webhook.name +} diff --git a/examples/hosted_dashboard/main.tf b/examples/hosted_dashboard/main.tf deleted file mode 100644 index 3fa9e619..00000000 --- a/examples/hosted_dashboard/main.tf +++ /dev/null @@ -1,28 +0,0 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.8" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - -resource "coralogix_hosted_dashboard" dashboard { - grafana { - config_json = file("./grafana_dashboard.json") - folder = coralogix_grafana_folder.test_folder.id - } -} - -resource "coralogix_grafana_folder" "test_folder" { - title = "Terraform Test Folder" -} - -data "coralogix_hosted_dashboard" imported_dashboard { - uid = coralogix_hosted_dashboard.dashboard.id -} diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf index f9e7e07a..5bd3df43 100644 --- a/examples/provider/provider.tf +++ b/examples/provider/provider.tf @@ -1,4 +1,13 @@ +terraform { + required_providers { + coralogix = { + version = "~> 1.8" + source = "coralogix/coralogix" + } + } +} + provider "coralogix" { #api_key = "" #env = "" -} \ No newline at end of file +} diff --git a/examples/resources/coralogix_events2metric/resource.tf b/examples/resources/coralogix_events2metric/resource.tf new file mode 100644 index 00000000..6313a277 --- /dev/null +++ b/examples/resources/coralogix_events2metric/resource.tf @@ -0,0 +1,79 @@ +resource "coralogix_events2metric" "logs2metric" { + name = "logs2metricExample" + description = "logs2metric from coralogix terraform provider" + logs_query = { + lucene = "remote_addr_enriched:/.*/" + applications = ["filter:startsWith:nginx"] //change here for existing applications from your account + severities = ["Debug"] + } + + metric_fields = { + method = { + source_field = "method" + }, + geo_point = { + source_field = "remote_addr_geoip.location_geopoint" + aggregations = { + max = { + enable = false + } + min = { + enable = false + } + avg = { + enable = true + } + } + } + } + + metric_labels = { + Status = "status" + Path = "http_referer" + } + + permutations = { + limit = 20000 + } +} + +resource "coralogix_events2metric" "spans2metric" { + name = "spans2metricExample" + description = "spans2metric from coralogix terraform provider" + + spans_query = { + lucene = "remote_addr_enriched:/.*/" + applications = ["filter:startsWith:nginx"] //change here for existing applications from your account + actions = ["action-name"] + services = ["service-name"] + } + + metric_fields = { + method = { + source_field = "method" + }, + geo_point = { + source_field = "remote_addr_geoip.location_geopoint" + aggregations = { + max = { + enable = false + } + min = { + enable = false + } + avg = { + enable = true + } + } + } + } + + metric_labels = { + Status = "status" + Path = "http_referer" + } + + permutations = { + limit = 20000 + } +} diff --git a/examples/group/main.tf b/examples/resources/coralogix_group/resource.tf similarity index 65% rename from examples/group/main.tf rename to examples/resources/coralogix_group/resource.tf index 8eb3b602..7481781d 100644 --- a/examples/group/main.tf +++ b/examples/resources/coralogix_group/resource.tf @@ -1,18 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.8" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - - resource "coralogix_user" "example" { user_name = "example@coralogix.com" name = { diff --git a/examples/hosted_dashboard/grafana_acc_dashboard.json b/examples/resources/coralogix_hosted_dashboard/grafana_acc_dashboard.json similarity index 100% rename from examples/hosted_dashboard/grafana_acc_dashboard.json rename to examples/resources/coralogix_hosted_dashboard/grafana_acc_dashboard.json diff --git a/examples/hosted_dashboard/grafana_acc_updated_dashboard.json b/examples/resources/coralogix_hosted_dashboard/grafana_acc_updated_dashboard.json similarity index 100% rename from examples/hosted_dashboard/grafana_acc_updated_dashboard.json rename to examples/resources/coralogix_hosted_dashboard/grafana_acc_updated_dashboard.json diff --git a/examples/hosted_dashboard/grafana_dashboard.json b/examples/resources/coralogix_hosted_dashboard/grafana_dashboard.json similarity index 100% rename from examples/hosted_dashboard/grafana_dashboard.json rename to examples/resources/coralogix_hosted_dashboard/grafana_dashboard.json diff --git a/examples/resources/coralogix_hosted_dashboard/resource.tf b/examples/resources/coralogix_hosted_dashboard/resource.tf new file mode 100644 index 00000000..ac0de031 --- /dev/null +++ b/examples/resources/coralogix_hosted_dashboard/resource.tf @@ -0,0 +1,12 @@ + +resource "coralogix_hosted_dashboard" dashboard { + grafana { + config_json = file("./grafana_dashboard.json") + folder = coralogix_grafana_folder.test_folder.id + } +} + +resource "coralogix_grafana_folder" "test_folder" { + title = "Terraform Test Folder" +} + diff --git a/examples/integration/main.tf b/examples/resources/coralogix_integration/resource.tf similarity index 54% rename from examples/integration/main.tf rename to examples/resources/coralogix_integration/resource.tf index 7cff162e..1c070059 100644 --- a/examples/integration/main.tf +++ b/examples/resources/coralogix_integration/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.8" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_integration" "example" { integration_key = "aws-metrics-collector" version = "0.1.0" @@ -26,8 +12,4 @@ resource "coralogix_integration" "example" { WithAggregations = false EnrichWithTags = true } -} - -data "coralogix_integration" "data_example" { - id = coralogix_integration.example.id } \ No newline at end of file diff --git a/examples/recording_rules_groups_set/main.tf b/examples/resources/coralogix_recording_rules_groups_set/resource.tf similarity index 70% rename from examples/recording_rules_groups_set/main.tf rename to examples/resources/coralogix_recording_rules_groups_set/resource.tf index 53943daf..52ab4d63 100644 --- a/examples/recording_rules_groups_set/main.tf +++ b/examples/resources/coralogix_recording_rules_groups_set/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.10" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_recording_rules_groups_set" recording_rules_group { yaml_content = file("./rule-group-set.yaml") } @@ -51,7 +37,3 @@ resource "coralogix_recording_rules_groups_set" recording_rules_groups_set_expli }, ] } - -data "coralogix_recording_rules_groups_set" "imported_recording_rules_groups_set" { - id = coralogix_recording_rules_groups_set.recording_rules_groups_set_explicit.id -} \ No newline at end of file diff --git a/examples/recording_rules_groups_set/rule-group-set.yaml b/examples/resources/coralogix_recording_rules_groups_set/rule-group-set.yaml similarity index 100% rename from examples/recording_rules_groups_set/rule-group-set.yaml rename to examples/resources/coralogix_recording_rules_groups_set/rule-group-set.yaml diff --git a/examples/rules_group/main.tf b/examples/resources/coralogix_rules_group/resource.tf similarity index 98% rename from examples/rules_group/main.tf rename to examples/resources/coralogix_rules_group/resource.tf index 59cbb2fa..2d016956 100644 --- a/examples/rules_group/main.tf +++ b/examples/resources/coralogix_rules_group/resource.tf @@ -95,10 +95,6 @@ resource "coralogix_rules_group" "rules_group_example" { } } -data "coralogix_rules_group" "imported_rules_group_example" { - id = coralogix_rules_group.rules_group_example.id -} - resource "coralogix_rules_group" "extract_timestamp_example" { name = "Example extract-timestamp rule-group from terraform" description = "rule_group created by coralogix terraform provider" diff --git a/examples/resources/coralogix_scope/resource.tf b/examples/resources/coralogix_scope/resource.tf new file mode 100644 index 00000000..ac14268c --- /dev/null +++ b/examples/resources/coralogix_scope/resource.tf @@ -0,0 +1,10 @@ +resource "coralogix_scope" "example" { + display_name = "ExampleScope" + default_expression = "true" + filters = [ + { + entity_type = "logs" + expression = "(subsystemName == 'purchases') || (subsystemName == 'signups')" + } + ] +} diff --git a/examples/slo/main.tf b/examples/resources/coralogix_slo/resource.tf similarity index 67% rename from examples/slo/main.tf rename to examples/resources/coralogix_slo/resource.tf index b6d20caf..80f1a593 100644 --- a/examples/slo/main.tf +++ b/examples/resources/coralogix_slo/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.8" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_slo" "example" { name = "coralogix_slo_example" service_name = "service_name" diff --git a/examples/tco_policies_logs/main.tf b/examples/resources/coralogix_tco_policies_logs/resource.tf similarity index 76% rename from examples/tco_policies_logs/main.tf rename to examples/resources/coralogix_tco_policies_logs/resource.tf index 4880cb99..ba9bdfe5 100644 --- a/examples/tco_policies_logs/main.tf +++ b/examples/resources/coralogix_tco_policies_logs/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.7" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_tco_policies_logs" "tco_policies" { policies = [ { @@ -70,8 +56,4 @@ resource "coralogix_tco_policies_logs" "tco_policies" { } } ] -} - -data "coralogix_tco_policies_logs" "data_tco_policies" { - depends_on = [coralogix_tco_policies_logs.tco_policies] -} +} \ No newline at end of file diff --git a/examples/tco_policies_traces/main.tf b/examples/resources/coralogix_tco_policies_traces/resource.tf similarity index 81% rename from examples/tco_policies_traces/main.tf rename to examples/resources/coralogix_tco_policies_traces/resource.tf index 8b8e2bcf..a147476f 100644 --- a/examples/tco_policies_traces/main.tf +++ b/examples/resources/coralogix_tco_policies_traces/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.8" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_tco_policies_traces" "tco_policies" { policies = [ { @@ -91,7 +77,3 @@ resource "coralogix_tco_policies_traces" "tco_policies" { } ] } - -data "coralogix_tco_policies_traces" "tco_policies_data" { - depends_on = [coralogix_tco_policies_traces.tco_policies] -} \ No newline at end of file diff --git a/examples/resources/coralogix_team/resource.tf b/examples/resources/coralogix_team/resource.tf new file mode 100644 index 00000000..e313b335 --- /dev/null +++ b/examples/resources/coralogix_team/resource.tf @@ -0,0 +1,5 @@ +resource "coralogix_team" "example" { + name = "exampleTeamName4" + daily_quota = 0.025 +} + diff --git a/examples/user/main.tf b/examples/resources/coralogix_user/resource.tf similarity index 62% rename from examples/user/main.tf rename to examples/resources/coralogix_user/resource.tf index 3ca93270..e808130d 100644 --- a/examples/user/main.tf +++ b/examples/resources/coralogix_user/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.8" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_custom_role" "example" { name = "Example custom role" description = "This role is created with terraform!" diff --git a/examples/webhook/main.tf b/examples/resources/coralogix_webhook/resource.tf similarity index 83% rename from examples/webhook/main.tf rename to examples/resources/coralogix_webhook/resource.tf index 045c82bc..8bb827f3 100644 --- a/examples/webhook/main.tf +++ b/examples/resources/coralogix_webhook/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.9" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_webhook" "slack_webhook" { name = "slack-webhook" slack = { @@ -25,14 +11,6 @@ resource "coralogix_webhook" "slack_webhook" { } } -data "coralogix_webhook" "imported_webhook_by_id" { - id = coralogix_webhook.slack_webhook.id -} - -data "coralogix_webhook" "imported_webhook_by_name" { - name = coralogix_webhook.slack_webhook.name -} - resource "coralogix_webhook" "custom_webhook" { name = "custom-webhook" custom = { diff --git a/examples/scope/main.tf b/examples/scope/main.tf deleted file mode 100644 index 570d3d65..00000000 --- a/examples/scope/main.tf +++ /dev/null @@ -1,28 +0,0 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.8" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - -resource "coralogix_scope" "example" { - display_name = "ExampleScope" - default_expression = "true" - filters = [ - { - entity_type = "logs" - expression = "(subsystemName == 'purchases') || (subsystemName == 'signups')" - } - ] -} - -data "coralogix_scope" "data_example" { - id = coralogix_scope.example.id -} \ No newline at end of file diff --git a/examples/team/main.tf b/examples/team/main.tf deleted file mode 100644 index 056b33aa..00000000 --- a/examples/team/main.tf +++ /dev/null @@ -1,19 +0,0 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.10" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - -resource "coralogix_team" "example" { - name = "exampleTeamName4" - daily_quota = 0.025 -} - From 5566b7acad862754cac38decbc43c6dd400aee17 Mon Sep 17 00:00:00 2001 From: Luigi Taglialatela Date: Fri, 8 Nov 2024 10:40:59 +0100 Subject: [PATCH 3/7] IAC-330 Rearrange examples --- examples/apikeys/main.tf | 28 ------ examples/archive_logs/main.tf | 17 ---- examples/archive_metrics/main.tf | 20 ---- examples/archive_retentions/main.tf | 32 ------ examples/dashboards_folder/main.tf | 22 ----- .../coralogix_action/data-source.tf | 3 + .../coralogix_api_key/data-source.tf | 4 + .../data-source.tf | 2 + .../coralogix_enrichment/data-source.tf | 3 + examples/events2metric/main.tf | 97 ------------------- .../resources/coralogix_action/resource.tf | 18 ---- .../coralogix_alert/resource.tf} | 14 --- .../coralogix_alerts_scheduler/resource.tf} | 14 --- .../resources/coralogix_api_key/resource.tf | 9 ++ .../coralogix_archive_logs/resource.tf | 3 + .../coralogix_archive_metrics/resource.tf | 6 ++ .../coralogix_archive_retentions/resource.tf | 15 +++ .../coralogix_custom_role/resource.tf} | 14 --- .../coralogix_dashboards_folder/resource.tf | 8 ++ .../date-to-day-of-the-week.csv | 0 .../coralogix_data_set/resource.tf} | 14 --- .../coralogix_enrichment/resource.tf} | 18 ---- .../{ => resources}/dashboard/dashboard.json | 0 .../dashboard/resource.tf} | 15 --- 24 files changed, 53 insertions(+), 323 deletions(-) delete mode 100644 examples/apikeys/main.tf delete mode 100644 examples/archive_logs/main.tf delete mode 100644 examples/archive_metrics/main.tf delete mode 100644 examples/archive_retentions/main.tf delete mode 100644 examples/dashboards_folder/main.tf create mode 100644 examples/data-sources/coralogix_action/data-source.tf create mode 100644 examples/data-sources/coralogix_api_key/data-source.tf create mode 100644 examples/data-sources/coralogix_archive_retentions/data-source.tf create mode 100644 examples/data-sources/coralogix_enrichment/data-source.tf delete mode 100644 examples/events2metric/main.tf rename examples/{alert/main.tf => resources/coralogix_alert/resource.tf} (97%) rename examples/{alerts_scheduler/main.tf => resources/coralogix_alerts_scheduler/resource.tf} (79%) create mode 100644 examples/resources/coralogix_api_key/resource.tf create mode 100644 examples/resources/coralogix_archive_logs/resource.tf create mode 100644 examples/resources/coralogix_archive_metrics/resource.tf create mode 100644 examples/resources/coralogix_archive_retentions/resource.tf rename examples/{custom_role/main.tf => resources/coralogix_custom_role/resource.tf} (62%) create mode 100644 examples/resources/coralogix_dashboards_folder/resource.tf rename examples/{data_set => resources/coralogix_data_set}/date-to-day-of-the-week.csv (100%) rename examples/{data_set/main.tf => resources/coralogix_data_set/resource.tf} (52%) rename examples/{enrichment/main.tf => resources/coralogix_enrichment/resource.tf} (62%) rename examples/{ => resources}/dashboard/dashboard.json (100%) rename examples/{dashboard/main.tf => resources/dashboard/resource.tf} (98%) diff --git a/examples/apikeys/main.tf b/examples/apikeys/main.tf deleted file mode 100644 index fee7d79f..00000000 --- a/examples/apikeys/main.tf +++ /dev/null @@ -1,28 +0,0 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.10" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { -# api_key = "" -# domain = "" -} - -resource "coralogix_api_key" "example" { - name = "My APM KEY" - owner = { - team_id : "4013254" - } - active = true - presets = ["APM"] - permissions = ["livetail:Read"] -} - -data "coralogix_api_key" "same_key_by_id" { - id = coralogix_api_key.example.id -} - diff --git a/examples/archive_logs/main.tf b/examples/archive_logs/main.tf deleted file mode 100644 index 78c6d656..00000000 --- a/examples/archive_logs/main.tf +++ /dev/null @@ -1,17 +0,0 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.10" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - -resource "coralogix_archive_logs" example { - bucket = "coralogix-c4c-eu2-prometheus-data" -} \ No newline at end of file diff --git a/examples/archive_metrics/main.tf b/examples/archive_metrics/main.tf deleted file mode 100644 index daed68da..00000000 --- a/examples/archive_metrics/main.tf +++ /dev/null @@ -1,20 +0,0 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.10" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - -resource "coralogix_archive_metrics" example { - s3 = { - region = "eu-north-1" - bucket = "coralogix-c4c-eu2-prometheus-data" - } -} diff --git a/examples/archive_retentions/main.tf b/examples/archive_retentions/main.tf deleted file mode 100644 index 92fa3781..00000000 --- a/examples/archive_retentions/main.tf +++ /dev/null @@ -1,32 +0,0 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.10" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - -resource "coralogix_archive_retentions" "example" { - retentions = [ - { - }, - { - name = "name_2" - }, - { - name = "name_3" - }, - { - name = "name_4" - }, - ] -} - -data "coralogix_archive_retentions" "example" { -} \ No newline at end of file diff --git a/examples/dashboards_folder/main.tf b/examples/dashboards_folder/main.tf deleted file mode 100644 index 487c48df..00000000 --- a/examples/dashboards_folder/main.tf +++ /dev/null @@ -1,22 +0,0 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.11" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - # env = "" -} - -resource "coralogix_dashboards_folder" "example" { - name = "example" -} - -resource "coralogix_dashboards_folder" "example_2" { - name = "example2" - parent_id = coralogix_dashboards_folder.example.id -} \ No newline at end of file diff --git a/examples/data-sources/coralogix_action/data-source.tf b/examples/data-sources/coralogix_action/data-source.tf new file mode 100644 index 00000000..43d3367b --- /dev/null +++ b/examples/data-sources/coralogix_action/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_action" imported_action { + id = coralogix_action.action.id +} \ No newline at end of file diff --git a/examples/data-sources/coralogix_api_key/data-source.tf b/examples/data-sources/coralogix_api_key/data-source.tf new file mode 100644 index 00000000..fda0a94f --- /dev/null +++ b/examples/data-sources/coralogix_api_key/data-source.tf @@ -0,0 +1,4 @@ +data "coralogix_api_key" "same_key_by_id" { + id = coralogix_api_key.example.id +} + diff --git a/examples/data-sources/coralogix_archive_retentions/data-source.tf b/examples/data-sources/coralogix_archive_retentions/data-source.tf new file mode 100644 index 00000000..18774ad5 --- /dev/null +++ b/examples/data-sources/coralogix_archive_retentions/data-source.tf @@ -0,0 +1,2 @@ +data "coralogix_archive_retentions" "example" { +} \ No newline at end of file diff --git a/examples/data-sources/coralogix_enrichment/data-source.tf b/examples/data-sources/coralogix_enrichment/data-source.tf new file mode 100644 index 00000000..08318ba2 --- /dev/null +++ b/examples/data-sources/coralogix_enrichment/data-source.tf @@ -0,0 +1,3 @@ +data "coralogix_enrichment" "imported_enrichment" { + id = coralogix_enrichment.geo_ip_enrichment.id +} \ No newline at end of file diff --git a/examples/events2metric/main.tf b/examples/events2metric/main.tf deleted file mode 100644 index 915cbfc3..00000000 --- a/examples/events2metric/main.tf +++ /dev/null @@ -1,97 +0,0 @@ -terraform { - required_providers { - coralogix = { - #version = "~> 1.5" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - -resource "coralogix_events2metric" "logs2metric" { - name = "logs2metricExample" - description = "logs2metric from coralogix terraform provider" - logs_query = { - lucene = "remote_addr_enriched:/.*/" - applications = ["filter:startsWith:nginx"] //change here for existing applications from your account - severities = ["Debug"] - } - - metric_fields = { - method = { - source_field = "method" - }, - geo_point = { - source_field = "remote_addr_geoip.location_geopoint" - aggregations = { - max = { - enable = false - } - min = { - enable = false - } - avg = { - enable = true - } - } - } - } - - metric_labels = { - Status = "status" - Path = "http_referer" - } - - permutations = { - limit = 20000 - } -} - -resource "coralogix_events2metric" "spans2metric" { - name = "spans2metricExample" - description = "spans2metric from coralogix terraform provider" - - spans_query = { - lucene = "remote_addr_enriched:/.*/" - applications = ["filter:startsWith:nginx"] //change here for existing applications from your account - actions = ["action-name"] - services = ["service-name"] - } - - metric_fields = { - method = { - source_field = "method" - }, - geo_point = { - source_field = "remote_addr_geoip.location_geopoint" - aggregations = { - max = { - enable = false - } - min = { - enable = false - } - avg = { - enable = true - } - } - } - } - - metric_labels = { - Status = "status" - Path = "http_referer" - } - - permutations = { - limit = 20000 - } -} - -data "coralogix_events2metric" "imported_logs2metric" { - id = coralogix_events2metric.logs2metric.id -} \ No newline at end of file diff --git a/examples/resources/coralogix_action/resource.tf b/examples/resources/coralogix_action/resource.tf index cd9154d0..bfcec1c2 100644 --- a/examples/resources/coralogix_action/resource.tf +++ b/examples/resources/coralogix_action/resource.tf @@ -1,24 +1,6 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.6" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_action" action { is_private = false source_type = "Log" name = "google search action" url = "https://www.google.com/search?q={{$p.selected_value}}" -} - -data "coralogix_action" imported_action { - id = coralogix_action.action.id } \ No newline at end of file diff --git a/examples/alert/main.tf b/examples/resources/coralogix_alert/resource.tf similarity index 97% rename from examples/alert/main.tf rename to examples/resources/coralogix_alert/resource.tf index 0ecc8862..6c08e7a4 100644 --- a/examples/alert/main.tf +++ b/examples/resources/coralogix_alert/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.11" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_alert" "standard_alert" { name = "Standard alert example" description = "Example of standard alert from terraform" diff --git a/examples/alerts_scheduler/main.tf b/examples/resources/coralogix_alerts_scheduler/resource.tf similarity index 79% rename from examples/alerts_scheduler/main.tf rename to examples/resources/coralogix_alerts_scheduler/resource.tf index 517cfc51..bdf4a957 100644 --- a/examples/alerts_scheduler/main.tf +++ b/examples/resources/coralogix_alerts_scheduler/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.10" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_alerts_scheduler" "example" { name = "example" description = "example" diff --git a/examples/resources/coralogix_api_key/resource.tf b/examples/resources/coralogix_api_key/resource.tf new file mode 100644 index 00000000..180fc005 --- /dev/null +++ b/examples/resources/coralogix_api_key/resource.tf @@ -0,0 +1,9 @@ +resource "coralogix_api_key" "example" { + name = "My APM KEY" + owner = { + team_id : "4013254" + } + active = true + presets = ["APM"] + permissions = ["livetail:Read"] +} diff --git a/examples/resources/coralogix_archive_logs/resource.tf b/examples/resources/coralogix_archive_logs/resource.tf new file mode 100644 index 00000000..883f2994 --- /dev/null +++ b/examples/resources/coralogix_archive_logs/resource.tf @@ -0,0 +1,3 @@ +resource "coralogix_archive_logs" example { + bucket = "coralogix-c4c-eu2-prometheus-data" +} \ No newline at end of file diff --git a/examples/resources/coralogix_archive_metrics/resource.tf b/examples/resources/coralogix_archive_metrics/resource.tf new file mode 100644 index 00000000..d9a173c8 --- /dev/null +++ b/examples/resources/coralogix_archive_metrics/resource.tf @@ -0,0 +1,6 @@ +resource "coralogix_archive_metrics" example { + s3 = { + region = "eu-north-1" + bucket = "coralogix-c4c-eu2-prometheus-data" + } +} diff --git a/examples/resources/coralogix_archive_retentions/resource.tf b/examples/resources/coralogix_archive_retentions/resource.tf new file mode 100644 index 00000000..ff227322 --- /dev/null +++ b/examples/resources/coralogix_archive_retentions/resource.tf @@ -0,0 +1,15 @@ +resource "coralogix_archive_retentions" "example" { + retentions = [ + { + }, + { + name = "name_2" + }, + { + name = "name_3" + }, + { + name = "name_4" + }, + ] +} diff --git a/examples/custom_role/main.tf b/examples/resources/coralogix_custom_role/resource.tf similarity index 62% rename from examples/custom_role/main.tf rename to examples/resources/coralogix_custom_role/resource.tf index 86e43724..aa3fdfc9 100644 --- a/examples/custom_role/main.tf +++ b/examples/resources/coralogix_custom_role/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.11" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_custom_role" "example" { name = "Example custom role" description = "This role is created with terraform!" diff --git a/examples/resources/coralogix_dashboards_folder/resource.tf b/examples/resources/coralogix_dashboards_folder/resource.tf new file mode 100644 index 00000000..077cd487 --- /dev/null +++ b/examples/resources/coralogix_dashboards_folder/resource.tf @@ -0,0 +1,8 @@ +resource "coralogix_dashboards_folder" "example" { + name = "example" +} + +resource "coralogix_dashboards_folder" "example_2" { + name = "example2" + parent_id = coralogix_dashboards_folder.example.id +} \ No newline at end of file diff --git a/examples/data_set/date-to-day-of-the-week.csv b/examples/resources/coralogix_data_set/date-to-day-of-the-week.csv similarity index 100% rename from examples/data_set/date-to-day-of-the-week.csv rename to examples/resources/coralogix_data_set/date-to-day-of-the-week.csv diff --git a/examples/data_set/main.tf b/examples/resources/coralogix_data_set/resource.tf similarity index 52% rename from examples/data_set/main.tf rename to examples/resources/coralogix_data_set/resource.tf index aa1e1868..9fa2f3f8 100644 --- a/examples/data_set/main.tf +++ b/examples/resources/coralogix_data_set/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.5" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_data_set" data_set { name = "custom enrichment data" description = "description" diff --git a/examples/enrichment/main.tf b/examples/resources/coralogix_enrichment/resource.tf similarity index 62% rename from examples/enrichment/main.tf rename to examples/resources/coralogix_enrichment/resource.tf index 206e2c07..d9c9ad53 100644 --- a/examples/enrichment/main.tf +++ b/examples/resources/coralogix_enrichment/resource.tf @@ -1,17 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "~> 1.5" - source = "coralogix/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - #env = "" -} - resource "coralogix_enrichment" geo_ip_enrichment { geo_ip { fields { @@ -44,8 +30,4 @@ resource "coralogix_data_set" data_set { name = "custom enrichment data" description = "description" file_content = file("../data_set/date-to-day-of-the-week.csv") -} - -data "coralogix_enrichment" "imported_enrichment" { - id = coralogix_enrichment.geo_ip_enrichment.id } \ No newline at end of file diff --git a/examples/dashboard/dashboard.json b/examples/resources/dashboard/dashboard.json similarity index 100% rename from examples/dashboard/dashboard.json rename to examples/resources/dashboard/dashboard.json diff --git a/examples/dashboard/main.tf b/examples/resources/dashboard/resource.tf similarity index 98% rename from examples/dashboard/main.tf rename to examples/resources/dashboard/resource.tf index 373aa8f7..b5c64da0 100644 --- a/examples/dashboard/main.tf +++ b/examples/resources/dashboard/resource.tf @@ -1,18 +1,3 @@ -terraform { - required_providers { - coralogix = { - version = "1.5" - source = "locally/debug/coralogix" - } - } -} - -provider "coralogix" { - #api_key = "" - # env = "" -} - - resource "coralogix_dashboard" dashboard { name = "portal monitoring" description = "" From 04d03da048ea79a032066fc92a7b4f19d44a1c25 Mon Sep 17 00:00:00 2001 From: Luigi Taglialatela Date: Fri, 8 Nov 2024 10:41:51 +0100 Subject: [PATCH 4/7] Regenerate docs --- docs/data-sources/action.md | 6 + docs/data-sources/alert.md | 2 +- docs/data-sources/api_key.md | 6 + docs/data-sources/archive_retentions.md | 5 + docs/data-sources/dashboard.md | 72 +-- docs/data-sources/enrichment.md | 6 + docs/data-sources/events2metric.md | 8 +- docs/data-sources/hosted_dashboard.md | 6 + docs/data-sources/integration.md | 6 + .../recording_rules_groups_set.md | 6 + docs/data-sources/rules_group.md | 6 + docs/data-sources/scope.md | 6 + docs/data-sources/slo.md | 6 +- docs/data-sources/tco_policies_logs.md | 10 +- docs/data-sources/tco_policies_traces.md | 6 + docs/data-sources/webhook.md | 14 +- docs/index.md | 20 +- docs/resources/action.md | 11 +- docs/resources/alert.md | 495 +++++++++++++++++- docs/resources/alerts_scheduler.md | 59 ++- docs/resources/api_key.md | 14 +- docs/resources/archive_logs.md | 6 + docs/resources/archive_metrics.md | 11 +- docs/resources/archive_retentions.md | 20 +- docs/resources/custom_role.md | 25 +- docs/resources/dashboard.md | 72 +-- docs/resources/dashboards_folder.md | 13 +- docs/resources/data_set.md | 18 +- docs/resources/enrichment.md | 38 +- docs/resources/events2metric.md | 86 ++- docs/resources/group.md | 30 +- docs/resources/hosted_dashboard.md | 15 +- docs/resources/integration.md | 20 +- docs/resources/recording_rules_groups_set.md | 44 +- docs/resources/rules_group.md | 163 +++++- docs/resources/scope.md | 15 +- docs/resources/slo.md | 37 +- docs/resources/tco_policies_logs.md | 68 ++- docs/resources/tco_policies_traces.md | 84 ++- docs/resources/team.md | 9 +- docs/resources/user.md | 25 +- docs/resources/webhook.md | 115 +++- 42 files changed, 1547 insertions(+), 137 deletions(-) diff --git a/docs/data-sources/action.md b/docs/data-sources/action.md index 859206b9..d8b587cd 100644 --- a/docs/data-sources/action.md +++ b/docs/data-sources/action.md @@ -10,7 +10,13 @@ description: |- Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/. +## Example Usage +```terraform +data "coralogix_action" imported_action { + id = coralogix_action.action.id +} +``` ## Schema diff --git a/docs/data-sources/alert.md b/docs/data-sources/alert.md index 8cde15b8..acb8d510 100644 --- a/docs/data-sources/alert.md +++ b/docs/data-sources/alert.md @@ -31,7 +31,7 @@ description: |- - `payload_filters` (Set of String) A list of log fields out of the log example which will be included with the alert notification. - `ratio` (List of Object) Alert based on the ratio between queries. (see [below for nested schema](#nestedatt--ratio)) - `scheduling` (List of Object) Limit the triggering of this alert to specific time frames. Active always by default. (see [below for nested schema](#nestedatt--scheduling)) -- `severity` (String) Determines the alert's severity. Can be one of ["Warning" "Critical" "Error" "Info"] +- `severity` (String) Determines the alert's severity. Can be one of ["Critical" "Error" "Info" "Warning"] - `standard` (List of Object) Alert based on number of log occurrences. (see [below for nested schema](#nestedatt--standard)) - `time_relative` (List of Object) Alert based on ratio between timeframes. (see [below for nested schema](#nestedatt--time_relative)) - `tracing` (List of Object) Alert based on tracing latency. (see [below for nested schema](#nestedatt--tracing)) diff --git a/docs/data-sources/api_key.md b/docs/data-sources/api_key.md index 88e61cf9..6f339d13 100644 --- a/docs/data-sources/api_key.md +++ b/docs/data-sources/api_key.md @@ -10,7 +10,13 @@ description: |- Coralogix Api keys. +## Example Usage +```terraform +data "coralogix_api_key" "same_key_by_id" { + id = coralogix_api_key.example.id +} +``` ## Schema diff --git a/docs/data-sources/archive_retentions.md b/docs/data-sources/archive_retentions.md index 79634135..c8138cf8 100644 --- a/docs/data-sources/archive_retentions.md +++ b/docs/data-sources/archive_retentions.md @@ -10,7 +10,12 @@ description: |- Coralogix archive-retention. For more info please review - https://coralogix.com/docs/archive-setup-grpc-api/. +## Example Usage +```terraform +data "coralogix_archive_retentions" "example" { +} +``` ## Schema diff --git a/docs/data-sources/dashboard.md b/docs/data-sources/dashboard.md index ef8f4860..4665b26b 100644 --- a/docs/data-sources/dashboard.md +++ b/docs/data-sources/dashboard.md @@ -365,7 +365,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -463,7 +463,7 @@ Read-Only: - `scale_type` (String) - `sort_by` (String) The field to sort by. Can be one of unspecified, value, name. - `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--stack_definition)) -- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. +- `unit` (String) The unit of the chart. Can be one of gbytes, euro_cents, euro, usd_cents, mbytes, microseconds, bytes, gibytes, unspecified, mibytes, usd, kbytes, seconds, bytes_iec, kibytes, milliseconds. - `xaxis` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--xaxis)) @@ -556,7 +556,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -697,7 +697,7 @@ Read-Only: Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -716,7 +716,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -735,7 +735,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -744,7 +744,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -791,7 +791,7 @@ Read-Only: - `order_by` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--order_by)) - `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query)) - `results_per_page` (Number) The number of results to display per page. -- `row_style` (String) The style of the rows. Can be one of ["one_line" "two_line" "condensed" "json"]. +- `row_style` (String) The style of the rows. Can be one of ["two_line" "condensed" "json" "one_line"]. ### Nested Schema for `layout.sections.rows.widgets.definition.data_table.columns` @@ -899,7 +899,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1053,7 +1053,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1089,7 +1089,7 @@ Read-Only: Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -1101,7 +1101,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1121,7 +1121,7 @@ Read-Only: - `show_outer_arc` (Boolean) - `threshold_by` (String) The threshold by. Can be one of ["unspecified" "value" "background"]. - `thresholds` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--thresholds)) -- `unit` (String) The unit of the gauge. Can be one of ["percent" "gbytes" "bytes_iec" "kibytes" "gibytes" "none" "kbytes" "mibytes" "euro" "usd_cents" "seconds" "mbytes" "euro_cents" "usd" "microseconds" "bytes" "milliseconds"]. +- `unit` (String) The unit of the gauge. Can be one of ["euro_cents" "usd_cents" "none" "microseconds" "milliseconds" "bytes_iec" "kibytes" "gibytes" "euro" "percent" "seconds" "mbytes" "gbytes" "kbytes" "usd" "bytes" "mibytes"]. ### Nested Schema for `layout.sections.rows.widgets.definition.gauge.query` @@ -1211,7 +1211,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1289,7 +1289,7 @@ Read-Only: Read-Only: -- `aggregation` (String) The type of aggregation. Can be one of ["unspecified" "last" "min" "max" "avg" "sum"]. +- `aggregation` (String) The type of aggregation. Can be one of ["last" "min" "max" "avg" "sum" "unspecified"]. - `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--metrics--filters)) - `promql_query` (String) @@ -1336,7 +1336,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1354,7 +1354,7 @@ Read-Only: Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -1386,7 +1386,7 @@ Read-Only: - `scale_type` (String) - `sort_by` (String) - `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--stack_definition)) -- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. +- `unit` (String) The unit of the chart. Can be one of gbytes, euro_cents, euro, usd_cents, mbytes, microseconds, bytes, gibytes, unspecified, mibytes, usd, kbytes, seconds, bytes_iec, kibytes, milliseconds. - `y_axis_view_by` (String) @@ -1524,7 +1524,7 @@ Read-Only: Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -1543,7 +1543,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1562,7 +1562,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1571,7 +1571,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1600,10 +1600,10 @@ Read-Only: Read-Only: -- `columns` (List of String) The columns to display in the legend. Valid values are: last, unspecified, min, max, sum, avg. +- `columns` (List of String) The columns to display in the legend. Valid values are: max, sum, avg, last, unspecified, min. - `group_by_query` (Boolean) - `is_visible` (Boolean) Whether to display the legend. False by default. -- `placement` (String) The placement of the legend. Valid values are: hidden, unspecified, auto, bottom, side. +- `placement` (String) The placement of the legend. Valid values are: unspecified, auto, bottom, side, hidden. @@ -1621,7 +1621,7 @@ Read-Only: - `scale_type` (String) The scale type. Valid values are: unspecified, linear, logarithmic. - `series_count_limit` (Number) - `series_name_template` (String) -- `unit` (String) The unit. Valid values are: unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. +- `unit` (String) The unit. Valid values are: gbytes, euro_cents, euro, usd_cents, mbytes, microseconds, bytes, gibytes, unspecified, mibytes, usd, kbytes, seconds, bytes_iec, kibytes, milliseconds. ### Nested Schema for `layout.sections.rows.widgets.definition.line_chart.query_definitions.query` @@ -1734,7 +1734,7 @@ Read-Only: Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -1753,7 +1753,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1772,7 +1772,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1793,7 +1793,7 @@ Read-Only: Read-Only: - `show_labels` (Boolean) -- `type` (String) The tooltip type. Valid values are: unspecified, all, single. +- `type` (String) The tooltip type. Valid values are: all, single, unspecified. @@ -1924,7 +1924,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2065,7 +2065,7 @@ Read-Only: Read-Only: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -2084,7 +2084,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2103,7 +2103,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2112,7 +2112,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2378,7 +2378,7 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2399,4 +2399,4 @@ Read-Only: Read-Only: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] diff --git a/docs/data-sources/enrichment.md b/docs/data-sources/enrichment.md index ab0f4085..45806fb5 100644 --- a/docs/data-sources/enrichment.md +++ b/docs/data-sources/enrichment.md @@ -10,7 +10,13 @@ description: |- +## Example Usage +```terraform +data "coralogix_enrichment" "imported_enrichment" { + id = coralogix_enrichment.geo_ip_enrichment.id +} +``` ## Schema diff --git a/docs/data-sources/events2metric.md b/docs/data-sources/events2metric.md index a7ef01b9..5e2ed564 100644 --- a/docs/data-sources/events2metric.md +++ b/docs/data-sources/events2metric.md @@ -10,7 +10,13 @@ description: |- +## Example Usage +```terraform +data "coralogix_events2metric" "imported_logs2metric" { + id = coralogix_events2metric.logs2metric.id +} +``` ## Schema @@ -33,7 +39,7 @@ Read-Only: - `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `lucene` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of severities that we interested in. Can be one of ["Unspecified" "Debug" "Verbose" "Info" "Warning" "Error" "Critical"] +- `severities` (Set of String) An array of severities that we interested in. Can be one of ["Debug" "Verbose" "Info" "Warning" "Error" "Critical" "Unspecified"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx diff --git a/docs/data-sources/hosted_dashboard.md b/docs/data-sources/hosted_dashboard.md index 371cfe6c..2092b320 100644 --- a/docs/data-sources/hosted_dashboard.md +++ b/docs/data-sources/hosted_dashboard.md @@ -10,7 +10,13 @@ description: |- +## Example Usage +```terraform +data "coralogix_hosted_dashboard" imported_dashboard { + uid = coralogix_hosted_dashboard.dashboard.id +} +``` ## Schema diff --git a/docs/data-sources/integration.md b/docs/data-sources/integration.md index c1676cda..cd4580ea 100644 --- a/docs/data-sources/integration.md +++ b/docs/data-sources/integration.md @@ -10,7 +10,13 @@ description: |- A Coralogix Integration +## Example Usage +```terraform +data "coralogix_integration" "data_example" { + id = coralogix_integration.example.id +} +``` ## Schema diff --git a/docs/data-sources/recording_rules_groups_set.md b/docs/data-sources/recording_rules_groups_set.md index 0eed0254..0526dcb4 100644 --- a/docs/data-sources/recording_rules_groups_set.md +++ b/docs/data-sources/recording_rules_groups_set.md @@ -10,7 +10,13 @@ description: |- +## Example Usage +```terraform +data "coralogix_recording_rules_groups_set" "imported_recording_rules_groups_set" { + id = coralogix_recording_rules_groups_set.recording_rules_groups_set_explicit.id +} +``` ## Schema diff --git a/docs/data-sources/rules_group.md b/docs/data-sources/rules_group.md index ed5f5548..6621d40b 100644 --- a/docs/data-sources/rules_group.md +++ b/docs/data-sources/rules_group.md @@ -10,7 +10,13 @@ description: |- +## Example Usage +```terraform +data "coralogix_rules_group" "imported_rules_group_example" { + id = coralogix_rules_group.rules_group_example.id +} +``` ## Schema diff --git a/docs/data-sources/scope.md b/docs/data-sources/scope.md index b883354a..8f7ab1e8 100644 --- a/docs/data-sources/scope.md +++ b/docs/data-sources/scope.md @@ -10,7 +10,13 @@ description: |- Coralogix Scope. +## Example Usage +```terraform +data "coralogix_scope" "data_example" { + id = coralogix_scope.example.id +} +``` ## Schema diff --git a/docs/data-sources/slo.md b/docs/data-sources/slo.md index f9988391..1b40d52a 100644 --- a/docs/data-sources/slo.md +++ b/docs/data-sources/slo.md @@ -24,13 +24,13 @@ Coralogix SLO. - `description` (String) Optional SLO description. - `filters` (Attributes Set) (see [below for nested schema](#nestedatt--filters)) - `name` (String) SLO name. -- `period` (String) Period. This is the period of the SLO. Valid values are: ["30_days" "unspecified" "7_days" "14_days"] +- `period` (String) Period. This is the period of the SLO. Valid values are: ["7_days" "14_days" "30_days" "unspecified"] - `remaining_error_budget_percentage` (Number) - `service_name` (String) Service name. This is the name of the service that the SLO is associated with. - `status` (String) - `target_percentage` (Number) Target percentage. This is the target percentage of the SLO. - `threshold_microseconds` (Number) Threshold in microseconds. Required when `type` is `latency`. -- `threshold_symbol_type` (String) Threshold symbol type. Required when `type` is `latency`. Valid values are: ["greater_or_equal" "less" "less_or_equal" "equal" "greater"] +- `threshold_symbol_type` (String) Threshold symbol type. Required when `type` is `latency`. Valid values are: ["greater" "greater_or_equal" "less" "less_or_equal" "equal"] - `type` (String) Type. This is the type of the SLO. Valid values are: "error", "latency". @@ -38,6 +38,6 @@ Coralogix SLO. Read-Only: -- `compare_type` (String) Compare type. This is the compare type of the SLO. Valid values are: ["unspecified" "is" "starts_with" "ends_with" "includes"] +- `compare_type` (String) Compare type. This is the compare type of the SLO. Valid values are: ["is" "starts_with" "ends_with" "includes" "unspecified"] - `field` (String) - `field_values` (Set of String) diff --git a/docs/data-sources/tco_policies_logs.md b/docs/data-sources/tco_policies_logs.md index 735eb398..a8947c0e 100644 --- a/docs/data-sources/tco_policies_logs.md +++ b/docs/data-sources/tco_policies_logs.md @@ -10,7 +10,13 @@ description: |- Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. +## Example Usage +```terraform +data "coralogix_tco_policies_logs" "data_tco_policies" { + depends_on = [coralogix_tco_policies_logs.tco_policies] +} +``` ## Schema @@ -33,7 +39,7 @@ Read-Only: - `name` (String) tco-policy name. - `order` (Number) The policy's order between the other policies. - `priority` (String) The policy priority. Can be one of ["block" "high" "low" "medium"]. -- `severities` (Set of String) The severities to apply the policy on. Can be few of ["critical" "debug" "verbose" "info" "warning" "error"]. +- `severities` (Set of String) The severities to apply the policy on. Can be few of ["warning" "error" "critical" "debug" "verbose" "info"]. - `subsystems` (Attributes) The subsystems to apply the policy on. Applies the policy on all the subsystems by default. (see [below for nested schema](#nestedatt--policies--subsystems)) @@ -42,7 +48,7 @@ Read-Only: Read-Only: - `names` (Set of String) -- `rule_type` (String) The rule type. Can be one of ["is" "is_not" "starts_with" "includes"]. +- `rule_type` (String) The rule type. Can be one of ["starts_with" "includes" "is" "is_not"]. diff --git a/docs/data-sources/tco_policies_traces.md b/docs/data-sources/tco_policies_traces.md index 41f649ce..a268a268 100644 --- a/docs/data-sources/tco_policies_traces.md +++ b/docs/data-sources/tco_policies_traces.md @@ -10,7 +10,13 @@ description: |- Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. +## Example Usage +```terraform +data "coralogix_tco_policies_traces" "tco_policies_data" { + depends_on = [coralogix_tco_policies_traces.tco_policies] +} +``` ## Schema diff --git a/docs/data-sources/webhook.md b/docs/data-sources/webhook.md index d9678294..48642c70 100644 --- a/docs/data-sources/webhook.md +++ b/docs/data-sources/webhook.md @@ -10,7 +10,17 @@ description: |- Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/. +## Example Usage +```terraform +data "coralogix_webhook" "imported_webhook_by_id" { + id = coralogix_webhook.slack_webhook.id +} + +data "coralogix_webhook" "imported_webhook_by_name" { + name = coralogix_webhook.slack_webhook.name +} +``` ## Schema @@ -41,7 +51,7 @@ Coralogix webhook. For more info please review - https://coralogix.com/docs/cora Read-Only: - `headers` (Map of String) Webhook headers. Map of string to string. -- `method` (String) Webhook method. can be one of: get, post, put +- `method` (String) Webhook method. can be one of: put, get, post - `payload` (String) Webhook payload. JSON string. - `url` (String) Webhook URL. - `uuid` (String) Webhook UUID. Computed automatically. @@ -145,4 +155,4 @@ Read-Only: Read-Only: - `active` (Boolean) Determines if the attachment is active. Default is true. -- `type` (String) Slack attachment type. can be one of: logs, empty, metric_snapshot +- `type` (String) Slack attachment type. can be one of: empty, metric_snapshot, logs diff --git a/docs/index.md b/docs/index.md index 55939f2b..c4987dec 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,23 @@ description: |- - +## Example Usage + +```terraform +terraform { + required_providers { + coralogix = { + version = "~> 1.8" + source = "coralogix/coralogix" + } + } +} + +provider "coralogix" { + #api_key = "" + #env = "" +} +``` ## Schema @@ -19,4 +35,4 @@ description: |- - `api_key` (String, Sensitive) A key for using coralogix APIs (Auto Generated), appropriate for the defined environment. environment variable 'CORALOGIX_API_KEY' can be defined instead. - `domain` (String) The Coralogix domain. Conflict With 'env'. environment variable 'CORALOGIX_DOMAIN' can be defined instead. -- `env` (String) The Coralogix API environment. can be one of ["USA1" "USA2" "AP1" "AP2" "EU1" "EUROPE2" "EU2" "APAC1" "APAC2" "EUROPE1" "US1" "US2"]. environment variable 'CORALOGIX_ENV' can be defined instead. +- `env` (String) The Coralogix API environment. can be one of ["AP2" "EUROPE1" "USA1" "US1" "EUROPE2" "EU2" "USA2" "US2" "APAC1" "AP1" "APAC2" "EU1"]. environment variable 'CORALOGIX_ENV' can be defined instead. diff --git a/docs/resources/action.md b/docs/resources/action.md index cda40781..6302c3e0 100644 --- a/docs/resources/action.md +++ b/docs/resources/action.md @@ -10,7 +10,16 @@ description: |- Coralogix action. For more info please review - https://coralogix.com/docs/coralogix-action-extension/. - +## Example Usage + +```terraform +resource "coralogix_action" action { + is_private = false + source_type = "Log" + name = "google search action" + url = "https://www.google.com/search?q={{$p.selected_value}}" +} +``` ## Schema diff --git a/docs/resources/alert.md b/docs/resources/alert.md index d473ff1c..097c09d0 100644 --- a/docs/resources/alert.md +++ b/docs/resources/alert.md @@ -10,7 +10,456 @@ description: |- Coralogix alert. More info: https://coralogix.com/docs/alerts-api/ . - +## Example Usage + +```terraform +resource "coralogix_alert" "standard_alert" { + name = "Standard alert example" + description = "Example of standard alert from terraform" + severity = "Critical" + + meta_labels = { + alert_type = "security" + security_severity = "high" + } + + notifications_group { + group_by_fields = ["coralogix.metadata.sdkId", "EventType"] + notification { + integration_id = coralogix_webhook.slack_webhook.external_id + } + notification { + email_recipients = ["example@coralogix.com"] + } + } + notifications_group { + notification { + email_recipients = ["example@coralogix.com"] + } + } + + incident_settings { + notify_on = "Triggered_and_resolved" + retriggering_period_minutes = 60 + } + + scheduling { + time_zone = "UTC+2" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + standard { + applications = ["filter:contains:nginx"] //change here for existing applications from your account + subsystems = ["filter:startsWith:subsystem-name"] //change here for existing subsystems from your account + severities = ["Warning", "Info"] + search_query = "remote_addr_enriched:/.*/" + condition { + more_than = true + threshold = 5 + time_window = "30Min" + group_by = ["coralogix.metadata.sdkId", "EventType"] + evaluation_window = "Dynamic" + } + } +} + +data "coralogix_alert" "imported_standard_alert" { + id = coralogix_alert.standard_alert.id +} + +resource "coralogix_alert" "ratio_alert" { + name = "Ratio alert example" + description = "Example of ratio alert from terraform" + severity = "Critical" + + notifications_group { + notification { + integration_id = coralogix_webhook.slack_webhook.external_id + retriggering_period_minutes = 1 + notify_on = "Triggered_only" + } + notification { + email_recipients = ["example@coralogix.com"] + retriggering_period_minutes = 1 + notify_on = "Triggered_and_resolved" + } + } + + scheduling { + time_zone = "UTC+2" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + ratio { + query_1 { + + } + query_2 { + applications = ["nginx"] //change here for existing applications from your account + subsystems = ["subsystem-name"] //change here for existing subsystems from your account + severities = ["Warning"] + } + condition { + less_than = true + ratio_threshold = 2 + time_window = "10Min" + group_by = ["coralogix.metadata.sdkId"] + group_by_q1 = true + manage_undetected_values { + enable_triggering_on_undetected_values = true + auto_retire_ratio = "5Min" + } + } + } +} + +resource "coralogix_alert" "new_value_alert" { + name = "New value alert example" + description = "Example of new value alert from terraform" + severity = "Info" + + notifications_group { + notification { + integration_id = coralogix_webhook.slack_webhook.external_id + retriggering_period_minutes = 1 + notify_on = "Triggered_only" + } + notification { + email_recipients = ["example@coralogix.com"] + retriggering_period_minutes = 1 + notify_on = "Triggered_and_resolved" + } + } + + scheduling { + time_zone = "UTC+2" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + new_value { + severities = ["Info"] + condition { + key_to_track = "remote_addr_geoip.country_name" + time_window = "12H" + } + } +} + +resource "coralogix_alert" "time_relative_alert" { + name = "Time relative alert example" + description = "Example of time relative alert from terraform" + severity = "Critical" + + notifications_group { + notification { + integration_id = coralogix_webhook.slack_webhook.external_id + } + notification { + email_recipients = ["example@coralogix.com"] + } + } + + incident_settings { + notify_on = "Triggered_and_resolved" + retriggering_period_minutes = 1 + } + + scheduling { + time_zone = "UTC+2" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + time_relative { + severities = ["Error"] + condition { + more_than = true + ratio_threshold = 2 + relative_time_window = "Same_hour_last_week" + } + } +} + +resource "coralogix_alert" "metric_lucene_alert" { + name = "Metric lucene alert example" + description = "Example of metric lucene alert from terraform" + severity = "Critical" + + notifications_group { + notification { + integration_id = coralogix_webhook.slack_webhook.external_id + } + notification { + email_recipients = ["example@coralogix.com"] + } + } + + incident_settings { + notify_on = "Triggered_and_resolved" + retriggering_period_minutes = 60 + } + + scheduling { + time_zone = "UTC+2" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + metric { + lucene { + search_query = "name:\"Frontend transactions\"" + condition { + metric_field = "subsystem" + arithmetic_operator = "Percentile" + arithmetic_operator_modifier = 20 + less_than = true + group_by = ["coralogix.metadata.sdkId"] + threshold = 60 + sample_threshold_percentage = 50 + time_window = "30Min" + manage_undetected_values { + enable_triggering_on_undetected_values = false + } + } + } + } +} + +resource "coralogix_alert" "metric_promql_alert" { + name = "Metric promql alert example" + description = "Example of metric promql alert from terraform" + severity = "Critical" + + notifications_group { + notification { + notify_on = "Triggered_and_resolved" + integration_id = coralogix_webhook.slack_webhook.external_id + retriggering_period_minutes = 1 + } + notification { + notify_on = "Triggered_and_resolved" + email_recipients = ["example@coralogix.com"] + retriggering_period_minutes = 24*60 + } + } + + scheduling { + time_zone = "UTC-8" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + metric { + promql { + search_query = "http_requests_total{status!~\"4..\"}" + condition { + less_than_usual = true + threshold = 3 + sample_threshold_percentage = 50 + time_window = "12H" + replace_missing_value_with_zero = true + } + } + } +} + +resource "coralogix_alert" "unique_count_alert" { + name = "Unique count alert example" + description = "Example of unique count alert from terraform" + severity = "Info" + + notifications_group { + group_by_fields = ["coralogix.metadata.sdkId"] + notification { + integration_id = coralogix_webhook.slack_webhook.external_id + retriggering_period_minutes = 1 + notify_on = "Triggered_and_resolved" + } + notification { + email_recipients = ["example@coralogix.com"] + retriggering_period_minutes = 1 + notify_on = "Triggered_and_resolved" + } + } + + scheduling { + time_zone = "UTC+2" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + unique_count { + severities = ["Info"] + condition { + unique_count_key = "remote_addr_geoip.country_name" + max_unique_values = 2 + time_window = "10Min" + group_by_key = "coralogix.metadata.sdkId" + max_unique_values_for_group_by = 500 + } + } +} + +resource "coralogix_alert" "tracing_alert" { + name = "Tracing alert example" + description = "Example of tracing alert from terraform" + severity = "Info" + + notifications_group { + notification { + notify_on = "Triggered_and_resolved" + email_recipients = ["user@example.com"] + retriggering_period_minutes = 1 + } + notification { + notify_on = "Triggered_and_resolved" + integration_id = coralogix_webhook.slack_webhook.external_id + retriggering_period_minutes = 1 + } + } + + scheduling { + time_zone = "UTC+2" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + tracing { + latency_threshold_milliseconds = 20.5 + applications = [ + "application_name", "filter:contains:application-name2", "filter:endsWith:application-name3", + "filter:startsWith:application-name4" + ] + subsystems = [ + "subsystemName", "filter:notEquals:subsystemName2", "filter:contains:subsystemName", + "filter:endsWith:subsystemName", + "filter:startsWith:subsystemName" + ] + services = [ + "serviceName", "filter:contains:serviceName", "filter:endsWith:serviceName", "filter:startsWith:serviceName" + ] + tag_filter { + field = "status" + values = ["filter:contains:400", "500"] + } + tag_filter { + field = "key" + values = ["value"] + } + condition { + more_than = true + time_window = "5Min" + threshold = 2 + } + } +} + +resource "coralogix_alert" "flow_alert" { + name = "Flow alert example" + description = "Example of flow alert from terraform" + severity = "Info" + + notifications_group { + notification { + notify_on = "Triggered_and_resolved" + email_recipients = ["user@example.com"] + retriggering_period_minutes = 1 + } + notification { + notify_on = "Triggered_and_resolved" + integration_id = coralogix_webhook.slack_webhook.external_id + retriggering_period_minutes = 1 + } + } + + scheduling { + time_zone = "UTC+2" + time_frame { + days_enabled = ["Wednesday", "Thursday"] + start_time = "08:30" + end_time = "20:30" + } + } + + flow { + stage { + group { + sub_alerts { + operator = "OR" + flow_alert { + user_alert_id = coralogix_alert.standard_alert.id + } + } + next_operator = "OR" + } + group { + sub_alerts { + operator = "AND" + flow_alert { + not = true + user_alert_id = coralogix_alert.unique_count_alert.id + } + } + next_operator = "AND" + } + time_window { + minutes = 20 + } + } + stage { + group { + sub_alerts { + operator = "AND" + flow_alert { + user_alert_id = coralogix_alert.standard_alert.id + } + flow_alert { + not = true + user_alert_id = coralogix_alert.unique_count_alert.id + } + } + next_operator = "OR" + } + } + group_by = ["coralogix.metadata.sdkId"] + } +} + +resource "coralogix_webhook" "slack_webhook" { + name = "slack-webhook" + slack = { + notify_on = ["flow_anomalies"] + url = "https://join.slack.com/example" + } +} +``` ## Schema @@ -18,7 +467,7 @@ Coralogix alert. More info: https://coralogix.com/docs/alerts-api/ . ### Required - `name` (String) Alert name. -- `severity` (String) Determines the alert's severity. Can be one of ["Warning" "Critical" "Error" "Info"] +- `severity` (String) Determines the alert's severity. Can be one of ["Critical" "Error" "Info" "Warning"] ### Optional @@ -151,11 +600,11 @@ Required: Required: -- `arithmetic_operator` (String) The arithmetic operator to use on the alert. can be one of ["Count" "Percentile" "Avg" "Min" "Max" "Sum"] +- `arithmetic_operator` (String) The arithmetic operator to use on the alert. can be one of ["Avg" "Min" "Max" "Sum" "Count" "Percentile"] - `metric_field` (String) The name of the metric field to alert on. - `sample_threshold_percentage` (Number) The metric value must cross the threshold within this percentage of the timeframe (sum and count arithmetic operators do not use this parameter since they aggregate over the entire requested timeframe), increments of 10, 0 <= value <= 100. - `threshold` (Number) The number of log threshold that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1Min" "15Min" "20Min" "1H" "2H" "4H" "6H" "12H" "24H" "5Min" "10Min" "30Min"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1Min" "5Min" "10Min" "6H" "24H" "4H" "12H" "15Min" "20Min" "30Min" "1H" "2H"] Optional: @@ -176,7 +625,7 @@ Required: Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["10Min" "1H" "2H" "6H" "12H" "24H" "Never" "5Min"] @@ -196,7 +645,7 @@ Required: - `sample_threshold_percentage` (Number) - `threshold` (Number) The threshold that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1Min" "15Min" "20Min" "1H" "2H" "4H" "6H" "12H" "24H" "5Min" "10Min" "30Min"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1Min" "5Min" "10Min" "6H" "24H" "4H" "12H" "15Min" "20Min" "30Min" "1H" "2H"] Optional: @@ -219,7 +668,7 @@ Required: Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["10Min" "1H" "2H" "6H" "12H" "24H" "Never" "5Min"] @@ -241,7 +690,7 @@ Optional: - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Debug" "Verbose" "Info" "Warning" "Error" "Critical"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx @@ -250,7 +699,7 @@ Optional: Required: - `key_to_track` (String) Select a key to track. Note, this key needs to have less than 50K unique values in the defined timeframe. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["12H" "24H" "48H" "72H" "1W" "1Month" "2Month" "3Month"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1Month" "2Month" "3Month" "12H" "24H" "48H" "72H" "1W"] @@ -289,7 +738,7 @@ Required: Required: - `ratio_threshold` (Number) The ratio(between the queries) threshold that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1H" "2H" "6H" "24H" "10Min" "15Min" "30Min" "4H" "12H" "36H" "5Min" "20Min"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["6H" "24H" "36H" "10Min" "20Min" "1H" "2H" "12H" "5Min" "15Min" "30Min" "4H"] Optional: @@ -311,7 +760,7 @@ Required: Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["10Min" "1H" "2H" "6H" "12H" "24H" "Never" "5Min"] @@ -328,7 +777,7 @@ Optional: - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Debug" "Verbose" "Info" "Warning" "Error" "Critical"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx @@ -340,7 +789,7 @@ Optional: - `alias` (String) Query2 alias. - `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Debug" "Verbose" "Info" "Warning" "Error" "Critical"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx @@ -361,7 +810,7 @@ Optional: Required: -- `days_enabled` (Set of String) Days of week. Can be one of ["Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"] +- `days_enabled` (Set of String) Days of week. Can be one of ["Wednesday" "Thursday" "Friday" "Saturday" "Sunday" "Monday" "Tuesday"] - `end_time` (String) Limit the triggering of this alert to end at specific hour. - `start_time` (String) Limit the triggering of this alert to start at specific hour. @@ -383,7 +832,7 @@ Optional: - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Debug" "Verbose" "Info" "Warning" "Error" "Critical"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx @@ -400,7 +849,7 @@ Optional: - `more_than` (Boolean) Determines the condition operator. Must be one of - immediately, less_than, more_than or more_than_usual. - `more_than_usual` (Boolean) Determines the condition operator. Must be one of - immediately, less_than, more_than or more_than_usual. - `threshold` (Number) The number of log occurrences that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1H" "2H" "6H" "24H" "10Min" "15Min" "30Min" "4H" "12H" "36H" "5Min" "20Min"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["6H" "24H" "36H" "10Min" "20Min" "1H" "2H" "12H" "5Min" "15Min" "30Min" "4H"] ### Nested Schema for `standard.condition.manage_undetected_values` @@ -411,7 +860,7 @@ Required: Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["10Min" "1H" "2H" "6H" "12H" "24H" "Never" "5Min"] @@ -432,7 +881,7 @@ Optional: - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Debug" "Verbose" "Info" "Warning" "Error" "Critical"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx @@ -441,7 +890,7 @@ Optional: Required: - `ratio_threshold` (Number) The ratio threshold that is needed to trigger the alert. -- `relative_time_window` (String) Time-window to compare with. Can be one of ["Previous_hour" "Same_hour_yesterday" "Same_hour_last_week" "Yesterday" "Same_day_last_week" "Same_day_last_month"]. +- `relative_time_window` (String) Time-window to compare with. Can be one of ["Yesterday" "Same_day_last_week" "Same_day_last_month" "Previous_hour" "Same_hour_yesterday" "Same_hour_last_week"]. Optional: @@ -460,7 +909,7 @@ Required: Optional: -- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["1H" "2H" "6H" "12H" "24H" "Never" "5Min" "10Min"] +- `auto_retire_ratio` (String) Defines the triggering auto-retire ratio. Can be one of ["10Min" "1H" "2H" "6H" "12H" "24H" "Never" "5Min"] @@ -500,7 +949,7 @@ Optional: - `immediately` (Boolean) Determines the condition operator. Must be one of - immediately or more_than. - `more_than` (Boolean) Determines the condition operator. Must be one of - immediately or more_than. - `threshold` (Number) The number of log occurrences that is needed to trigger the alert. -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["1H" "2H" "6H" "24H" "10Min" "15Min" "30Min" "4H" "12H" "36H" "5Min" "20Min"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["6H" "24H" "36H" "10Min" "20Min" "1H" "2H" "12H" "5Min" "15Min" "30Min" "4H"] @@ -529,7 +978,7 @@ Optional: - `ip_addresses` (Set of String) An array that contains log’s IP addresses that we want to be notified on. - `methods` (Set of String) An array that contains log’s method names that we want to be notified on. - `search_query` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Error" "Critical" "Debug" "Verbose" "Info" "Warning"] +- `severities` (Set of String) An array of log severities that we interested in. Can be one of ["Debug" "Verbose" "Info" "Warning" "Error" "Critical"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx @@ -538,7 +987,7 @@ Optional: Required: - `max_unique_values` (Number) -- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["6H" "12H" "15Min" "20Min" "30Min" "1H" "4H" "24H" "1Min" "5Min" "10Min" "2H"] +- `time_window` (String) The bounded time frame for the threshold to be occurred within, to trigger the alert. Can be one of ["30Min" "1H" "2H" "12H" "24H" "15Min" "5Min" "10Min" "20Min" "4H" "6H" "1Min"] - `unique_count_key` (String) Defines the key to match to track its unique count. Optional: diff --git a/docs/resources/alerts_scheduler.md b/docs/resources/alerts_scheduler.md index 880398a5..537fa280 100644 --- a/docs/resources/alerts_scheduler.md +++ b/docs/resources/alerts_scheduler.md @@ -10,7 +10,64 @@ description: |- Coralogix alerts-scheduler. - +## Example Usage + +```terraform +resource "coralogix_alerts_scheduler" "example" { + name = "example" + description = "example" + filter = { + what_expression = "source logs | filter $d.cpodId:string == '122'" + alerts_unique_ids = ["ed6f3713-d827-49a2-9bb6-a8dba8b8c580"] + } + schedule = { + operation = "mute" + one_time = { + time_frame = { + start_time = "2021-01-04T00:00:00.000" + end_time = "2025-01-01T00:00:50.000" + time_zone = "UTC+2" + } + } + } +} + +resource "coralogix_alerts_scheduler" "example_2" { + name = "example" + description = "example" + filter = { + what_expression = "source logs | filter $d.cpodId:string == '122'" + meta_labels = [ + { + key = "key" + value = "value" + } + ] + } + schedule = { + operation = "active" + recurring = { + dynamic = { + repeat_every = 2 + frequency = { + weekly = { + days = ["Sunday"] + } + } + time_frame = { + start_time = "2021-01-04T00:00:00.000" + duration = { + for_over = 2 + frequency = "hours" + } + time_zone = "UTC+2" + } + termination_date = "2025-01-01T00:00:00.000" + } + } + } +} +``` ## Schema diff --git a/docs/resources/api_key.md b/docs/resources/api_key.md index 637ec946..f9fe42fa 100644 --- a/docs/resources/api_key.md +++ b/docs/resources/api_key.md @@ -10,7 +10,19 @@ description: |- Coralogix Api keys. - +## Example Usage + +```terraform +resource "coralogix_api_key" "example" { + name = "My APM KEY" + owner = { + team_id : "4013254" + } + active = true + presets = ["APM"] + permissions = ["livetail:Read"] +} +``` ## Schema diff --git a/docs/resources/archive_logs.md b/docs/resources/archive_logs.md index ad61b01d..5374f72c 100644 --- a/docs/resources/archive_logs.md +++ b/docs/resources/archive_logs.md @@ -10,7 +10,13 @@ description: |- +## Example Usage +```terraform +resource "coralogix_archive_logs" example { + bucket = "coralogix-c4c-eu2-prometheus-data" +} +``` ## Schema diff --git a/docs/resources/archive_metrics.md b/docs/resources/archive_metrics.md index b36add5c..2c4670a0 100644 --- a/docs/resources/archive_metrics.md +++ b/docs/resources/archive_metrics.md @@ -10,7 +10,16 @@ description: |- - +## Example Usage + +```terraform +resource "coralogix_archive_metrics" example { + s3 = { + region = "eu-north-1" + bucket = "coralogix-c4c-eu2-prometheus-data" + } +} +``` ## Schema diff --git a/docs/resources/archive_retentions.md b/docs/resources/archive_retentions.md index 58115bc6..d0b5da89 100644 --- a/docs/resources/archive_retentions.md +++ b/docs/resources/archive_retentions.md @@ -10,7 +10,25 @@ description: |- Coralogix archive-retention. For more info please review - https://coralogix.com/docs/archive-setup-grpc-api/. - +## Example Usage + +```terraform +resource "coralogix_archive_retentions" "example" { + retentions = [ + { + }, + { + name = "name_2" + }, + { + name = "name_3" + }, + { + name = "name_4" + }, + ] +} +``` ## Schema diff --git a/docs/resources/custom_role.md b/docs/resources/custom_role.md index 08a19661..a156e407 100644 --- a/docs/resources/custom_role.md +++ b/docs/resources/custom_role.md @@ -10,7 +10,30 @@ description: |- Coralogix Custom roles. - +## Example Usage + +```terraform +resource "coralogix_custom_role" "example" { + name = "Example custom role" + description = "This role is created with terraform!" + parent_role = "Standard User" + permissions = ["spans.events2metrics:UpdateConfig"] +} + +resource "coralogix_user" "example" { + user_name = "example@coralogix.com" + name = { + given_name = "example" + family_name = "example" + } +} + +resource "coralogix_group" "example" { + display_name = "example" + role = coralogix_custom_role.example.name + members = [coralogix_user.example.id] +} +``` ## Schema diff --git a/docs/resources/dashboard.md b/docs/resources/dashboard.md index a7a05647..c8c72d9a 100644 --- a/docs/resources/dashboard.md +++ b/docs/resources/dashboard.md @@ -389,7 +389,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -508,7 +508,7 @@ Optional: - `scale_type` (String) - `sort_by` (String) The field to sort by. Can be one of unspecified, value, name. - `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--stack_definition)) -- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. +- `unit` (String) The unit of the chart. Can be one of gbytes, euro_cents, euro, usd_cents, mbytes, microseconds, bytes, gibytes, unspecified, mibytes, usd, kbytes, seconds, bytes_iec, kibytes, milliseconds. - `xaxis` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--bar_chart--xaxis)) @@ -613,7 +613,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -778,7 +778,7 @@ Optional: Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -797,7 +797,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -819,7 +819,7 @@ Optional: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -828,7 +828,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -875,7 +875,7 @@ Required: - `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--data_table--query)) - `results_per_page` (Number) The number of results to display per page. -- `row_style` (String) The style of the rows. Can be one of ["one_line" "two_line" "condensed" "json"]. +- `row_style` (String) The style of the rows. Can be one of ["two_line" "condensed" "json" "one_line"]. Optional: @@ -980,7 +980,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1158,7 +1158,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1200,7 +1200,7 @@ Read-Only: Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -1212,7 +1212,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1246,7 +1246,7 @@ Optional: Required: - `query` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query)) -- `unit` (String) The unit of the gauge. Can be one of ["percent" "gbytes" "bytes_iec" "kibytes" "gibytes" "none" "kbytes" "mibytes" "euro" "usd_cents" "seconds" "mbytes" "euro_cents" "usd" "microseconds" "bytes" "milliseconds"]. +- `unit` (String) The unit of the gauge. Can be one of ["euro_cents" "usd_cents" "none" "microseconds" "milliseconds" "bytes_iec" "kibytes" "gibytes" "euro" "percent" "seconds" "mbytes" "gbytes" "kbytes" "usd" "bytes" "mibytes"]. Optional: @@ -1355,7 +1355,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1452,7 +1452,7 @@ Required: Optional: -- `aggregation` (String) The type of aggregation. Can be one of ["unspecified" "last" "min" "max" "avg" "sum"]. +- `aggregation` (String) The type of aggregation. Can be one of ["last" "min" "max" "avg" "sum" "unspecified"]. - `filters` (Attributes List) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--gauge--query--metrics--filters)) @@ -1504,7 +1504,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1525,7 +1525,7 @@ Optional: Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -1557,7 +1557,7 @@ Optional: - `scale_type` (String) - `sort_by` (String) - `stack_definition` (Attributes) (see [below for nested schema](#nestedatt--layout--sections--rows--widgets--definition--horizontal_bar_chart--stack_definition)) -- `unit` (String) The unit of the chart. Can be one of unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. +- `unit` (String) The unit of the chart. Can be one of gbytes, euro_cents, euro, usd_cents, mbytes, microseconds, bytes, gibytes, unspecified, mibytes, usd, kbytes, seconds, bytes_iec, kibytes, milliseconds. - `y_axis_view_by` (String) @@ -1716,7 +1716,7 @@ Optional: Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -1735,7 +1735,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1757,7 +1757,7 @@ Optional: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1766,7 +1766,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1810,7 +1810,7 @@ Optional: - `scale_type` (String) The scale type. Valid values are: unspecified, linear, logarithmic. - `series_count_limit` (Number) - `series_name_template` (String) -- `unit` (String) The unit. Valid values are: unspecified, milliseconds, mbytes, kibytes, seconds, euro_cents, microseconds, bytes, bytes_iec, gibytes, euro, usd, kbytes, gbytes, mibytes, usd_cents. +- `unit` (String) The unit. Valid values are: gbytes, euro_cents, euro, usd_cents, mbytes, microseconds, bytes, gibytes, unspecified, mibytes, usd, kbytes, seconds, bytes_iec, kibytes, milliseconds. Read-Only: @@ -1948,7 +1948,7 @@ Optional: Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -1967,7 +1967,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -1989,7 +1989,7 @@ Optional: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2009,10 +2009,10 @@ Optional: Optional: -- `columns` (List of String) The columns to display in the legend. Valid values are: last, unspecified, min, max, sum, avg. +- `columns` (List of String) The columns to display in the legend. Valid values are: max, sum, avg, last, unspecified, min. - `group_by_query` (Boolean) - `is_visible` (Boolean) Whether to display the legend. False by default. -- `placement` (String) The placement of the legend. Valid values are: hidden, unspecified, auto, bottom, side. +- `placement` (String) The placement of the legend. Valid values are: unspecified, auto, bottom, side, hidden. @@ -2021,7 +2021,7 @@ Optional: Optional: - `show_labels` (Boolean) -- `type` (String) The tooltip type. Valid values are: unspecified, all, single. +- `type` (String) The tooltip type. Valid values are: all, single, unspecified. @@ -2167,7 +2167,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2332,7 +2332,7 @@ Optional: Required: -- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["sum" "percentile_99" "percentile_95" "percentile_50" "unspecified" "min" "max" "avg"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. +- `aggregation_type` (String) The type of the aggregation. When the aggregation type is `metrics`, can be one of ["percentile_95" "percentile_50" "unspecified" "min" "max" "avg" "sum" "percentile_99"]. When the aggregation type is `dimension`, can be one of ["unspecified" "unique_count" "error_count"]. - `field` (String) The field to aggregate on. When the aggregation type is `metrics`, can be one of ["unspecified" "duration"]. When the aggregation type is `dimension`, can be one of ["unspecified" "trace_id"]. - `type` (String) Can be one of ["metric" "dimension"] @@ -2351,7 +2351,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2373,7 +2373,7 @@ Optional: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2382,7 +2382,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2660,7 +2660,7 @@ Required: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] @@ -2681,4 +2681,4 @@ Optional: Required: - `type` (String) The type of the field. Can be one of ["metadata" "tag" "process_tag"] -- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["unspecified" "application_name" "subsystem_name" "service_name" "operation_name"] +- `value` (String) The value of the field. When the field type is `metadata`, can be one of ["operation_name" "unspecified" "application_name" "subsystem_name" "service_name"] diff --git a/docs/resources/dashboards_folder.md b/docs/resources/dashboards_folder.md index 7ddd53dc..9501b19a 100644 --- a/docs/resources/dashboards_folder.md +++ b/docs/resources/dashboards_folder.md @@ -10,7 +10,18 @@ description: |- - +## Example Usage + +```terraform +resource "coralogix_dashboards_folder" "example" { + name = "example" +} + +resource "coralogix_dashboards_folder" "example_2" { + name = "example2" + parent_id = coralogix_dashboards_folder.example.id +} +``` ## Schema diff --git a/docs/resources/data_set.md b/docs/resources/data_set.md index 7601fb5b..d1404656 100644 --- a/docs/resources/data_set.md +++ b/docs/resources/data_set.md @@ -10,7 +10,23 @@ description: |- - +## Example Usage + +```terraform +resource "coralogix_data_set" data_set { + name = "custom enrichment data" + description = "description" + file_content = file("./date-to-day-of-the-week.csv") +} + +resource "coralogix_data_set" data_set2 { + name = "custom enrichment data 2" + description = "description" + uploaded_file { + path = "./date-to-day-of-the-week.csv" + } +} +``` ## Schema diff --git a/docs/resources/enrichment.md b/docs/resources/enrichment.md index da00bc25..36f3ed8c 100644 --- a/docs/resources/enrichment.md +++ b/docs/resources/enrichment.md @@ -10,7 +10,43 @@ description: |- - +## Example Usage + +```terraform +resource "coralogix_enrichment" geo_ip_enrichment { + geo_ip { + fields { + name = "coralogix.metadata.sdkId" + } + fields { + name = "coralogix.metadata.IPAddress" + } + } +} + +resource "coralogix_enrichment" suspicious_ip_enrichment { + suspicious_ip { + fields { + name = "coralogix.metadata.sdkId" + } + } +} + +resource "coralogix_enrichment" custom_enrichment { + custom { + custom_enrichment_id = coralogix_data_set.data_set.id + fields { + name = "coralogix.metadata.IPAddress" + } + } +} + +resource "coralogix_data_set" data_set { + name = "custom enrichment data" + description = "description" + file_content = file("../data_set/date-to-day-of-the-week.csv") +} +``` ## Schema diff --git a/docs/resources/events2metric.md b/docs/resources/events2metric.md index 8f47bbeb..0b59d11a 100644 --- a/docs/resources/events2metric.md +++ b/docs/resources/events2metric.md @@ -10,7 +10,89 @@ description: |- - +## Example Usage + +```terraform +resource "coralogix_events2metric" "logs2metric" { + name = "logs2metricExample" + description = "logs2metric from coralogix terraform provider" + logs_query = { + lucene = "remote_addr_enriched:/.*/" + applications = ["filter:startsWith:nginx"] //change here for existing applications from your account + severities = ["Debug"] + } + + metric_fields = { + method = { + source_field = "method" + }, + geo_point = { + source_field = "remote_addr_geoip.location_geopoint" + aggregations = { + max = { + enable = false + } + min = { + enable = false + } + avg = { + enable = true + } + } + } + } + + metric_labels = { + Status = "status" + Path = "http_referer" + } + + permutations = { + limit = 20000 + } +} + +resource "coralogix_events2metric" "spans2metric" { + name = "spans2metricExample" + description = "spans2metric from coralogix terraform provider" + + spans_query = { + lucene = "remote_addr_enriched:/.*/" + applications = ["filter:startsWith:nginx"] //change here for existing applications from your account + actions = ["action-name"] + services = ["service-name"] + } + + metric_fields = { + method = { + source_field = "method" + }, + geo_point = { + source_field = "remote_addr_geoip.location_geopoint" + aggregations = { + max = { + enable = false + } + min = { + enable = false + } + avg = { + enable = true + } + } + } + } + + metric_labels = { + Status = "status" + Path = "http_referer" + } + + permutations = { + limit = 20000 + } +} +``` ## Schema @@ -39,7 +121,7 @@ Optional: - `applications` (Set of String) An array that contains log’s application names that we want to be alerted on. Applications can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx - `lucene` (String) The search_query that we wanted to be notified on. -- `severities` (Set of String) An array of severities that we interested in. Can be one of ["Unspecified" "Debug" "Verbose" "Info" "Warning" "Error" "Critical"] +- `severities` (Set of String) An array of severities that we interested in. Can be one of ["Debug" "Verbose" "Info" "Warning" "Error" "Critical" "Unspecified"] - `subsystems` (Set of String) An array that contains log’s subsystem names that we want to be notified on. Subsystems can be filtered by prefix, suffix, and contains using the next patterns - filter:startsWith:xxx, filter:endsWith:xxx, filter:contains:xxx diff --git a/docs/resources/group.md b/docs/resources/group.md index cdf6cc78..70dfbf25 100644 --- a/docs/resources/group.md +++ b/docs/resources/group.md @@ -10,7 +10,35 @@ description: |- Coralogix group. - +## Example Usage + +```terraform +resource "coralogix_user" "example" { + user_name = "example@coralogix.com" + name = { + given_name = "example" + family_name = "example" + } +} + +resource "coralogix_scope" "example" { + display_name = "ExampleScope" + default_expression = "true" + filters = [ + { + entity_type = "logs" + expression = "(subsystemName == 'purchases') || (subsystemName == 'signups')" + } + ] +} + +resource "coralogix_group" "example" { + display_name = "example" + role = "Read Only" + members = [coralogix_user.example.id] + scope_id = coralogix_scope.example.id +} +``` ## Schema diff --git a/docs/resources/hosted_dashboard.md b/docs/resources/hosted_dashboard.md index d54aeea1..ee95b89e 100644 --- a/docs/resources/hosted_dashboard.md +++ b/docs/resources/hosted_dashboard.md @@ -10,7 +10,20 @@ description: |- Hosted dashboard. Can be one of - ["grafana"]. - +## Example Usage + +```terraform +resource "coralogix_hosted_dashboard" dashboard { + grafana { + config_json = file("./grafana_dashboard.json") + folder = coralogix_grafana_folder.test_folder.id + } +} + +resource "coralogix_grafana_folder" "test_folder" { + title = "Terraform Test Folder" +} +``` ## Schema diff --git a/docs/resources/integration.md b/docs/resources/integration.md index a153df45..5b227cad 100644 --- a/docs/resources/integration.md +++ b/docs/resources/integration.md @@ -10,7 +10,25 @@ description: |- A Coralogix Integration - +## Example Usage + +```terraform +resource "coralogix_integration" "example" { + integration_key = "aws-metrics-collector" + version = "0.1.0" + # Note that the attribute casing is important here + parameters = { + ApplicationName = "cxsdk" + SubsystemName = "aws-metrics-collector" + MetricNamespaces = ["AWS/S3"] + AwsRoleArn = "arn:aws:iam::123456789012:role/example-role" + IntegrationName = "sdk-integration-setup" + AwsRegion = "eu-north-1" + WithAggregations = false + EnrichWithTags = true + } +} +``` ## Schema diff --git a/docs/resources/recording_rules_groups_set.md b/docs/resources/recording_rules_groups_set.md index 600a0ec0..92b348b0 100644 --- a/docs/resources/recording_rules_groups_set.md +++ b/docs/resources/recording_rules_groups_set.md @@ -10,7 +10,49 @@ description: |- - +## Example Usage + +```terraform +resource "coralogix_recording_rules_groups_set" recording_rules_group { + yaml_content = file("./rule-group-set.yaml") +} + +resource "coralogix_recording_rules_groups_set" recording_rules_groups_set_explicit { + name = "Name" + groups = [ + { + name = "Foo" + interval = 180 + limit = 100 + rules = [ + { + record = "ts3db_live_ingester_write_latency:3m" + expr = "sum(rate(ts3db_live_ingester_write_latency_seconds_count{CX_LEVEL=\"staging\",pod=~\"ts3db-live-ingester.*\"}[2m])) by (pod)" + }, + { + record = "job:http_requests_total:sum" + expr = "sum(rate(http_requests_total[5m])) by (job)" + }, + ] + }, + { + name = "Bar" + interval = 180 + limit = 100 + rules = [ + { + record = "ts3db_live_ingester_write_latency:3m" + expr = "sum(rate(ts3db_live_ingester_write_latency_seconds_count{CX_LEVEL=\"staging\",pod=~\"ts3db-live-ingester.*\"}[2m])) by (pod)" + }, + { + record = "job:http_requests_total:sum" + expr = "sum(rate(http_requests_total[5m])) by (job)" + }, + ] + }, + ] +} +``` ## Schema diff --git a/docs/resources/rules_group.md b/docs/resources/rules_group.md index 6eda3fef..4fcabc07 100644 --- a/docs/resources/rules_group.md +++ b/docs/resources/rules_group.md @@ -10,7 +10,166 @@ description: |- Rule-group is list of rule-subgroups with 'and' (&&) operation between. For more info please review - https://coralogix.com/docs/log-parsing-rules/ . - +## Example Usage + +```terraform +terraform { + required_providers { + coralogix = { + version = "~> 1.5" + source = "coralogix/coralogix" + } + } +} + +provider "coralogix" { + #api_key = "" + #env = "" +} + +resource "coralogix_rules_group" "rules_group_example" { + name = "Example rule-group from terraform" + description = "rule_group creates by coralogix terraform provider" + applications = ["nginx"] //change here for existing applications from your account + subsystems = ["subsystem-name"] //change here for existing subsystems from your account + severities = ["Warning"] + order = 1 + + rule_subgroups { + rules { + extract { + name = "Severity Rule" + description = "Look for default severity text" + source_field = "text" + regular_expression = "message\\s*:s*(?P\\d+)\\s*.*?status\\sis\\s(?P\\[^\"]+)" + } + } + + rules { + json_extract { + name = "Worker to category" + description = "Extracts value from 'worker' and populates 'Category'" + json_key = "worker" + destination_field = "Text" + destination_field_text = "text.free_text" + } + } + + rules { + replace { + name = "Delete prefix" + description = "Deletes data before Json" + source_field = "text" + destination_field = "text" + replacement_string = "{" + regular_expression = ".*{" + } + } + + rules { + block { + name = "Block 28000" + description = "Block 2800 pg error" + source_field = "text" + regular_expression = "sql_error_code\\s*=\\s*28000" + } + } + } + + rule_subgroups { + rules { + parse { + name = "HttpRequestParser1" + description = "Parse the fields of the HTTP request" + source_field = "text" + destination_field = "text" + regular_expression = "(?P\\d{1,3}.\\d{1,3}.\\d{1,3}.\\d{1,3})\\s*-\\s*(?P[^ ]+)\\s*\\[(?P\\d{4}-\\d{2}\\-\\d{2}T\\d{2}\\:\\d{2}\\:\\d{2}\\.\\d{1,6}Z)\\]\\s*\\\\\\\"(?P[A-z]+)\\s[\\/\\\\]+(?P[^\\s]+)\\s*(?P[A-z0-9\\/\\.]+)\\\\\\\"\\s*(?P\\d+)\\s*(?P\\d+)?\\s*?\\\\\\\"(?P[^\"]+)\\\"\\s*\\\\\\\"(?P[^\"]+)\\\"\\s(?P\\d{1,6})\\s*(?P\\d{1,6})" + } + } + + rules { + parse { + name = "HttpRequestParser2" + description = "Parse the fields of the HTTP request - will be applied after HttpRequestParser1" + source_field = "text" + destination_field = "text" + regular_expression = "(?P\\d{1,3}.\\d{1,3}.\\d{1,3}.\\d{1,3})\\s*-\\s*(?P[^ ]+)\\s*\\[(?P\\d{4}-\\d{2}\\-\\d{2}T\\d{2}\\:\\d{2}\\:\\d{2}\\.\\d{1,6}Z)\\]\\s*\\\\\\\"(?P[A-z]+)\\s[\\/\\\\]+(?P[^\\s]+)\\s*(?P[A-z0-9\\/\\.]+)\\\\\\\"\\s*(?P\\d+)\\s*(?P\\d+)?\\s*?\\\\\\\"(?P[^\"]+)\\\"\\s*\\\\\\\"(?P[^\"]+)\\\"\\s(?P\\d{1,6})\\s*(?P\\d{1,6})" + } + } + + rules { + json_stringify { + name = "json_stringify rule" + source_field = "text" + destination_field = "text" + keep_source_field = "false" + #for better example look at - https://coralogix.com/docs/log-parsing-rules/#stringify-json-fields + } + } + + } +} + +resource "coralogix_rules_group" "extract_timestamp_example" { + name = "Example extract-timestamp rule-group from terraform" + description = "rule_group created by coralogix terraform provider" + applications = ["nginx"] //change here for existing applications from your account + subsystems = ["subsystem-name"] //change here for existing subsystems from your account + severities = ["Warning"] + order = 4 + + rule_subgroups { + rules { + extract_timestamp { + name = "example extract-timestamp rule from terraform" + description = "rule created by coralogix terraform provider" + source_field = "text" + field_format_standard = "Strftime" + time_format = "%Y-%m-%dT%H:%M:%S.%f%z" + } + } + } +} + +resource "coralogix_rules_group" "remove_fields_example" { + name = "Example remove-fields rule-group from terraform" + description = "rule_group created by coralogix terraform provider" + applications = ["nginx"] //change here for existing applications from your account + subsystems = ["subsystem-name"] //change here for existing subsystems from your account + severities = ["Warning"] + order = 3 + rule_subgroups { + rules { + remove_fields { + name = "Example remove-fields rule from terraform" + description = "rule created by coralogix terraform provider" + excluded_fields = ["coralogix.metadata.applicationName", "coralogix.metadata.className"] + } + } + } +} + +resource "coralogix_rules_group" "parse_json_field_example" { + name = "Example parse-json-field rule-group from terraform" + description = "rule_group created by coralogix terraform provider" + applications = ["nginx"] //change here for existing applications from your account + subsystems = ["subsystem-name"] //change here for existing subsystems from your account + severities = ["Warning"] + order = 2 + rule_subgroups { + rules { + parse_json_field { + name = "Example parse-json-field rule from terraform" + description = "rule created by coralogix terraform provider" + source_field = "text" + destination_field = "text" + keep_source_field = "true" + keep_destination_field = "true" + } + } + } +} +``` ## Schema @@ -135,7 +294,7 @@ Read-Only: Required: -- `destination_field` (String) The field that will be populated by the results of RegEx operation.Can be one of [Class Method ThreadID Severity Text Category]. +- `destination_field` (String) The field that will be populated by the results of RegEx operation.Can be one of [Severity Text Category Class Method ThreadID]. - `json_key` (String) JSON key to extract its value directly into a Coralogix metadata field. - `name` (String) The rule name. diff --git a/docs/resources/scope.md b/docs/resources/scope.md index 4bfd4eed..e018b943 100644 --- a/docs/resources/scope.md +++ b/docs/resources/scope.md @@ -10,7 +10,20 @@ description: |- Coralogix Scope. - +## Example Usage + +```terraform +resource "coralogix_scope" "example" { + display_name = "ExampleScope" + default_expression = "true" + filters = [ + { + entity_type = "logs" + expression = "(subsystemName == 'purchases') || (subsystemName == 'signups')" + } + ] +} +``` ## Schema diff --git a/docs/resources/slo.md b/docs/resources/slo.md index e2c9f78f..e40ba365 100644 --- a/docs/resources/slo.md +++ b/docs/resources/slo.md @@ -10,7 +10,36 @@ description: |- Coralogix SLO. - +## Example Usage + +```terraform +resource "coralogix_slo" "example" { + name = "coralogix_slo_example" + service_name = "service_name" + description = "description" + target_percentage = 30 + type = "error" + period = "7_days" +} + +resource "coralogix_slo" "example_2" { + name = "coralogix_slo_example" + service_name = "service_name" + description = "description" + target_percentage = 30 + type = "latency" + threshold_microseconds = 1000000 + threshold_symbol_type = "greater" + period = "7_days" + filters = [ + { + field = "severity" + compare_type = "is" + field_values = ["error", "warning"] + }, + ] +} +``` ## Schema @@ -18,7 +47,7 @@ Coralogix SLO. ### Required - `name` (String) SLO name. -- `period` (String) Period. This is the period of the SLO. Valid values are: ["30_days" "unspecified" "7_days" "14_days"] +- `period` (String) Period. This is the period of the SLO. Valid values are: ["7_days" "14_days" "30_days" "unspecified"] - `service_name` (String) Service name. This is the name of the service that the SLO is associated with. - `target_percentage` (Number) Target percentage. This is the target percentage of the SLO. - `type` (String) Type. This is the type of the SLO. Valid values are: "error", "latency". @@ -28,7 +57,7 @@ Coralogix SLO. - `description` (String) Optional SLO description. - `filters` (Attributes Set) (see [below for nested schema](#nestedatt--filters)) - `threshold_microseconds` (Number) Threshold in microseconds. Required when `type` is `latency`. -- `threshold_symbol_type` (String) Threshold symbol type. Required when `type` is `latency`. Valid values are: ["greater_or_equal" "less" "less_or_equal" "equal" "greater"] +- `threshold_symbol_type` (String) Threshold symbol type. Required when `type` is `latency`. Valid values are: ["greater" "greater_or_equal" "less" "less_or_equal" "equal"] ### Read-Only @@ -41,7 +70,7 @@ Coralogix SLO. Required: -- `compare_type` (String) Compare type. This is the compare type of the SLO. Valid values are: ["unspecified" "is" "starts_with" "ends_with" "includes"] +- `compare_type` (String) Compare type. This is the compare type of the SLO. Valid values are: ["is" "starts_with" "ends_with" "includes" "unspecified"] - `field` (String) Optional: diff --git a/docs/resources/tco_policies_logs.md b/docs/resources/tco_policies_logs.md index ee6d459d..9f9a197c 100644 --- a/docs/resources/tco_policies_logs.md +++ b/docs/resources/tco_policies_logs.md @@ -10,7 +10,69 @@ description: |- Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. - +## Example Usage + +```terraform +resource "coralogix_tco_policies_logs" "tco_policies" { + policies = [ + { + name = "Example tco_policy from terraform 1" + priority = "low" + severities = ["debug", "verbose", "info"] + applications = { + rule_type = "starts_with" + names = ["prod"] + } + subsystems = { + rule_type = "is" + names = ["mobile", "web"] + } + archive_retention_id = "e1c980d0-c910-4c54-8326-67f3cf95645a" + }, + { + name = "Example tco_policy from terraform 2" + priority = "medium" + severities = ["error", "warning", "critical"] + applications = { + rule_type = "starts_with" + names = ["prod"] + } + subsystems = { + rule_type = "is" + names = ["mobile", "web"] + } + }, + { + name = "Example tco_policy from terraform 3" + priority = "high" + + severities = ["error", "warning", "critical"] + applications = { + rule_type = "starts_with" + names = ["prod"] + } + subsystems = { + rule_type = "is" + names = ["mobile", "web"] + } + }, + { + name = "Example tco_policy from terraform 4" + priority = "high" + + severities = ["error", "warning", "critical"] + applications = { + rule_type = "starts_with" + names = ["prod"] + } + subsystems = { + rule_type = "is" + names = ["mobile", "web"] + } + } + ] +} +``` ## Schema @@ -37,7 +99,7 @@ Optional: - `archive_retention_id` (String) Allowing logs with a specific retention to be tagged. - `description` (String) The policy description - `enabled` (Boolean) Determines weather the policy will be enabled. True by default. -- `severities` (Set of String) The severities to apply the policy on. Can be few of ["critical" "debug" "verbose" "info" "warning" "error"]. +- `severities` (Set of String) The severities to apply the policy on. Can be few of ["warning" "error" "critical" "debug" "verbose" "info"]. - `subsystems` (Attributes) The subsystems to apply the policy on. Applies the policy on all the subsystems by default. (see [below for nested schema](#nestedatt--policies--subsystems)) Read-Only: @@ -54,7 +116,7 @@ Required: Optional: -- `rule_type` (String) The rule type. Can be one of ["is" "is_not" "starts_with" "includes"]. +- `rule_type` (String) The rule type. Can be one of ["starts_with" "includes" "is" "is_not"]. diff --git a/docs/resources/tco_policies_traces.md b/docs/resources/tco_policies_traces.md index 0bfc343b..0838cec7 100644 --- a/docs/resources/tco_policies_traces.md +++ b/docs/resources/tco_policies_traces.md @@ -10,7 +10,89 @@ description: |- Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. - +## Example Usage + +```terraform +resource "coralogix_tco_policies_traces" "tco_policies" { + policies = [ + { + name = "Example tco_policy from terraform 1" + priority = "low" + applications = { + rule_type = "starts_with" + names = ["prod"] + } + subsystems = { + rule_type = "is" + names = ["mobile", "web"] + } + actions = { + rule_type = "is_not" + names = ["action-name", "action-name2"] + } + services = { + rule_type = "is" + names = ["service-name", "service-name2"] + } + tags = { + "tags.http.method" = { + rule_type = "includes" + names = ["GET"] + } + } + archive_retention_id = "e1c980d0-c910-4c54-8326-67f3cf95645a" + }, + { + name = "Example tco_policy from terraform 2" + priority = "medium" + applications = { + rule_type = "starts_with" + names = ["staging"] + } + subsystems = { + rule_type = "is_not" + names = ["mobile", "web"] + } + actions = { + names = ["action-name", "action-name2"] + } + services = { + names = ["service-name", "service-name2"] + } + tags = { + "tags.http.method" = { + rule_type = "is_not" + names = ["GET", "POST"] + } + } + }, + { + name = "Example tco_policy from terraform 3" + priority = "medium" + applications = { + rule_type = "starts_with" + names = ["staging"] + } + subsystems = { + rule_type = "is_not" + names = ["mobile", "web"] + } + actions = { + names = ["action-name", "action-name2"] + } + services = { + names = ["service-name", "service-name2"] + } + tags = { + "tags.http.method" = { + rule_type = "is_not" + names = ["GET", "POST"] + } + } + } + ] +} +``` ## Schema diff --git a/docs/resources/team.md b/docs/resources/team.md index 8110b640..42c6986c 100644 --- a/docs/resources/team.md +++ b/docs/resources/team.md @@ -10,7 +10,14 @@ description: |- Coralogix Team. - +## Example Usage + +```terraform +resource "coralogix_team" "example" { + name = "exampleTeamName4" + daily_quota = 0.025 +} +``` ## Schema diff --git a/docs/resources/user.md b/docs/resources/user.md index 91d02515..6b7277b8 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -10,7 +10,30 @@ description: |- Coralogix User. - +## Example Usage + +```terraform +resource "coralogix_custom_role" "example" { + name = "Example custom role" + description = "This role is created with terraform!" + parent_role = "Standard User" + permissions = ["spans.events2metrics:UpdateConfig"] +} + +resource "coralogix_user" "example" { + user_name = "example@coralogix.com" + name = { + given_name = "example" + family_name = "example" + } +} + +resource "coralogix_group" "example" { + display_name = "example" + role = coralogix_custom_role.example.name + members = [coralogix_user.example.id] +} +``` ## Schema diff --git a/docs/resources/webhook.md b/docs/resources/webhook.md index 8d6bb17f..470d055d 100644 --- a/docs/resources/webhook.md +++ b/docs/resources/webhook.md @@ -10,7 +10,116 @@ description: |- Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/. - +## Example Usage + +```terraform +resource "coralogix_webhook" "slack_webhook" { + name = "slack-webhook" + slack = { + notify_on = ["flow_anomalies"] + url = "https://join.slack.com/example" + attachments = [ + { + type = "metric_snapshot" + active = true + }] + } +} + +resource "coralogix_webhook" "custom_webhook" { + name = "custom-webhook" + custom = { + method = "post" + headers = { "Content-Type" : "application/json" } + url = "https://example-url.com/" + } +} + +resource "coralogix_webhook" "pager_duty_webhook" { + name = "pagerduty-webhook" + pager_duty = { + service_key = "service-key" + } +} + +resource "coralogix_webhook" "email_group_webhook" { + name = "email-group-webhook" + email_group = { + emails = ["user@example.com"] + } +} + +resource "coralogix_webhook" "microsoft_teams_webhook" { + name = "microsoft-teams-webhook" + microsoft_teams_workflow = { + url = "https://example-url.com/" + } +} + +resource "coralogix_webhook" "jira_webhook" { + name = "jira-webhook" + jira = { + api_token = "api-token" + email = "example@coralogix.com" + project_key = "project-key" + url = "https://coralogix.atlassian.net/jira/your-work" + } +} + +resource "coralogix_webhook" "opsgenie_webhook" { + name = "opsgenie-webhook" + opsgenie = { + url = "https://example-url.com/" + } +} + +resource "coralogix_webhook" "demisto_webhook" { + name = "demisto-webhook" + demisto = { + url = "https://example-url.com/" + } +} + +resource "coralogix_webhook" "sendlog_webhook" { + name = "sendlog-webhook" + sendlog = { + url = "https://example-url.com/" + } +} + +resource "coralogix_webhook" "event_bridge_webhook" { + name = "event_bridge_webhook" + event_bridge = { + event_bus_arn = "arn:aws:events:us-east-1:123456789012:event-bus/default" + detail = "example_detail" + detail_type = "example_detail_type" + source = "example_source" + role_name = "example_role_name" + } +} + +//example of how to use webhooks that was created via terraform +resource "coralogix_alert" "standard_alert" { + name = "Standard alert example" + description = "Example of standard alert from terraform" + severity = "Critical" + + notifications_group { + notification { + integration_id = coralogix_webhook.slack_webhook.external_id + retriggering_period_minutes = 60 + notify_on = "Triggered_only" + } + } + + standard { + search_query = "remote_addr_enriched:/.*/" + condition { + immediately = true + } + } +} +``` ## Schema @@ -41,7 +150,7 @@ Coralogix webhook. For more info please review - https://coralogix.com/docs/cora Optional: - `headers` (Map of String) Webhook headers. Map of string to string. -- `method` (String) Webhook method. can be one of: get, post, put +- `method` (String) Webhook method. can be one of: put, get, post - `payload` (String) Webhook payload. JSON string. - `url` (String) Webhook URL. - `uuid` (String) Webhook UUID. Computed automatically. @@ -156,7 +265,7 @@ Optional: Required: -- `type` (String) Slack attachment type. can be one of: logs, empty, metric_snapshot +- `type` (String) Slack attachment type. can be one of: empty, metric_snapshot, logs Optional: From e05b22e3133c01f348de5ae7237bf22612541905 Mon Sep 17 00:00:00 2001 From: Claus Matzinger Date: Fri, 8 Nov 2024 10:58:57 +0100 Subject: [PATCH 5/7] docs: dashboards --- .../coralogix_dashboard/dashboard.json | 1237 +++++++++++++++++ .../resources/coralogix_dashboard/resource.tf | 614 ++++++++ 2 files changed, 1851 insertions(+) create mode 100644 examples/resources/coralogix_dashboard/dashboard.json create mode 100644 examples/resources/coralogix_dashboard/resource.tf diff --git a/examples/resources/coralogix_dashboard/dashboard.json b/examples/resources/coralogix_dashboard/dashboard.json new file mode 100644 index 00000000..42df0f31 --- /dev/null +++ b/examples/resources/coralogix_dashboard/dashboard.json @@ -0,0 +1,1237 @@ +{ + "id": "pMjswgFSqRAhgiXqyzOXq", + "name": "OpenTelemetry Collector Dashboard", + "description": "Gives insights into your Collector stats.", + "layout": { + "sections": [ + { + "id": { + "value": "17d55a1f-9f31-491d-ad77-b54eeb3fe7b3" + }, + "rows": [ + { + "id": { + "value": "bebd0e5b-2fad-4446-a0f3-e1f32de4528b" + }, + "appearance": { + "height": 19 + }, + "widgets": [ + { + "id": { + "value": "5f414b12-54af-43bc-a941-915f28e445f9" + }, + "title": "Accepted Records", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "040f6cd8-6a3e-5091-858a-2174ef6589df", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_receiver_accepted_log_records_total{}[5m])) by (receiver)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "ea52cc9e-f30f-e820-8aee-5fc18aa412fb", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_receiver_accepted_metric_points_total{}[5m])) by (receiver)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Metrics", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "fcaf6c6c-3ca6-3c3a-3186-2593aa6389ed", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_receiver_accepted_spans_total{}[5m])) by (receiver)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Spans", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + }, + { + "id": { + "value": "a2f20751-99ea-40ea-876a-c1ec8b27a88e" + }, + "title": "Refused Records", + "description": "Number of records per second failed to consume due to errors", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "b99dd44c-bf45-877d-ccad-070cd4123fff", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_receiver_refused_log_records_total{}[5m])) by (receiver)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "6f6f5041-a5e4-0b06-3cc2-b6b10ef82b07", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_receiver_refused_metric_points_total{}[5m])) by (receiver)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Metrics", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "119f4dfa-9ac2-a526-38a3-0b2e1bbf2ae8", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_receiver_refused_spans_total{}[5m])) by (receiver)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Spans", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + } + ] + } + ], + "options": { + "custom": { + "name": " Receivers", + "collapsed": false, + "color": { + "predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED" + } + } + } + }, + { + "id": { + "value": "47814d45-4256-4f3e-b801-743ed71002a7" + }, + "rows": [ + { + "id": { + "value": "0218d08c-05e2-4403-a6a9-d550138247a2" + }, + "appearance": { + "height": 19 + }, + "widgets": [ + { + "id": { + "value": "622ae85f-b598-4fab-bed3-4df4405d9148" + }, + "title": "Accepted Records", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "71eb4c2a-bf4b-4d1d-3eb4-ce28fc176512", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_accepted_log_records_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "fc2485de-5626-9c1d-06a5-9f0f1d75537b", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_accepted_metric_points_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Metrics", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "e5ec6336-b068-305f-5739-a6f1944679a5", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_accepted_metric_points_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Spans", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + }, + { + "id": { + "value": "b4fb25d4-0816-4ef3-92ec-0cf6ab1c688f" + }, + "title": "Rejected Records", + "description": "Memory limitter typically rejects records due to memory issues", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "8bba398a-5436-5e6c-c5b1-f3f1fa7ae533", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_refused_log_records_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "a90a9f69-d565-deb1-20e6-384639911e92", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_refused_metric_points_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Metrics", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "6d85b8cf-dcdf-b9f7-5f68-a04600768536", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_refused_spans_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Spans", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + }, + { + "id": { + "value": "471a384d-1c17-4bdc-adc2-b9ba03e4a933" + }, + "title": "Dropped Records", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "a571bc5d-316b-b92f-a658-26f4726b1421", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_dropped_log_records_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "e99737d5-7171-38d9-999d-5f3da98c3b65", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_dropped_metric_points_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Metrics", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "f9152179-2a8b-5771-008a-40ae828d00a9", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_dropped_spans_total{}[5m])) by (processor)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Spans", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + } + ] + }, + { + "id": { + "value": "eea5a0de-f7b6-4cb4-bd51-2871ff31b8fb" + }, + "appearance": { + "height": 19 + }, + "widgets": [ + { + "id": { + "value": "8ab6cb77-9721-4711-8c2e-f147083a3a1e" + }, + "title": "Batch Processor - Batch Size", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "961286d1-e898-d722-3dec-a67f06de6514", + "query": { + "metrics": { + "promqlQuery": { + "value": "histogram_quantile(0.95, sum(rate(otelcol_processor_batch_batch_send_size_bucket[5m])) by (le))" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesNameTemplate": "90 quanile", + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "90 quantile", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "4fd2d736-7c9f-e5a0-15d2-0efe93d6cea4", + "query": { + "metrics": { + "promqlQuery": { + "value": "histogram_quantile(0.5, sum(rate(otelcol_processor_batch_batch_send_size_bucket[5m])) by (le))" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesNameTemplate": "50 quanile", + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "50 quantile", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "f7dbd5e9-3175-215d-622b-79d25d8bbb71", + "query": { + "logs": { + "groupBy": [], + "aggregations": [ + { + "count": {} + } + ], + "filters": [], + "groupBys": [] + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + }, + { + "id": { + "value": "2a833e44-32b3-4804-9ea0-abba8dca7dec" + }, + "title": "Batch Processor - Batches Sent", + "description": "Batches sent per second", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "676b81fe-273f-330b-8f21-d770b8bae03e", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_processor_batch_batch_send_size_count))" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesNameTemplate": "batch/s", + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + } + ] + } + ], + "options": { + "custom": { + "name": " Processors", + "collapsed": false, + "color": { + "predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED" + } + } + } + }, + { + "id": { + "value": "4e96a18a-8652-4f7d-a643-f9098b5044c3" + }, + "rows": [ + { + "id": { + "value": "a7badf8b-9fb3-475d-8c24-eba381833ff6" + }, + "appearance": { + "height": 19 + }, + "widgets": [ + { + "id": { + "value": "90a803fe-4ffd-44e4-bee1-7d3ac589f185" + }, + "title": "Sent Records", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "0625b4a9-e020-afd6-7392-c5bc64cd2cb8", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_exporter_sent_log_records_total{}[5m])) by (exporter)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "23636684-3845-c6c9-57d7-ceb62ab0b7a1", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_exporter_sent_metric_points_total{}[5m])) by (exporter)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Metrics", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "4b65fcab-90cd-5bbf-d86f-3c0affd09d7e", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_exporter_sent_spans_total{}[5m])) by (exporter)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Spans", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + }, + { + "id": { + "value": "e4aa882e-f53c-4a36-a4e9-c79c7e1ed4b5" + }, + "title": "Send Failures", + "description": "Number of records per second failed to publish", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "b0a86deb-ebc7-d8e2-fb68-e52e273b52fa", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_exporter_send_failed_log_records_total{}[5m])) by (exporter)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "e9a060cc-2331-7371-e30a-68f96508d7e2", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_exporter_send_failed_metric_points_total{}[5m])) by (exporter)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Metrics", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "a6a83e9a-a6be-adad-4305-76b99065e644", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_exporter_send_failed_spans_total{}[5m])) by (exporter)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Spans", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + }, + { + "id": { + "value": "b70dc5c1-404a-41ee-b35d-f07d058bf9b5" + }, + "title": "Queue size", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "d947376a-1506-427b-9872-735ae39de094", + "query": { + "metrics": { + "promqlQuery": { + "value": "min(otelcol_exporter_queue_capacity) by (k8s_pod_name)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesNameTemplate": "capacity", + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Queue Size", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + }, + { + "id": "6dad89f7-a465-1d9b-4bc1-5b65549f912f", + "query": { + "metrics": { + "promqlQuery": { + "value": "max (otelcol_exporter_queue_size{}) by (k8s_pod_name)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Capacity", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + } + ] + } + ], + "options": { + "custom": { + "name": "Exporters", + "collapsed": false, + "color": { + "predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED" + } + } + } + }, + { + "id": { + "value": "876bd617-c801-4fee-91da-8dfe3ddddeea" + }, + "rows": [ + { + "id": { + "value": "6c5782ee-7ac1-4cf4-a3eb-0c509948bb7d" + }, + "appearance": { + "height": 19 + }, + "widgets": [ + { + "id": { + "value": "458c0756-7952-433b-b8ca-d13f10aeff79" + }, + "title": "CPU usage", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "077325c9-50da-5359-a45f-98fa5cd867dd", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(otelcol_process_cpu_seconds_total{}[5m])) by (k8s_pod_name)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + }, + { + "id": { + "value": "5c8af89b-9779-423e-ba72-d109f471564e" + }, + "title": "Memory usage", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "bfa0b11e-9ccd-1ba1-951d-3e2a3ee0c3c1", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(otelcol_process_memory_rss) by (k8s_pod_name)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_BYTES_IEC", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + } + ] + }, + { + "id": { + "value": "65591fbf-00b4-4693-8c3d-41ac6199c3bc" + }, + "appearance": { + "height": 19 + }, + "widgets": [ + { + "id": { + "value": "d6278001-c95d-49df-91b1-3766675a8a23" + }, + "title": "Network usage", + "description": "Bytes per Second", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "8f9c31f2-64b5-bd92-8195-26d728bf1b6c", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(rate(k8s_pod_network_io_By_total{k8s_pod_name=~\"coralogix-opentelemetry.*\"}[5m])) by (k8s_pod_name)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_UNSPECIFIED", + "scaleType": "SCALE_TYPE_LINEAR", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + }, + { + "id": { + "value": "6c4c143f-7d8e-42e5-b139-cc6cae51e3ce" + }, + "title": "Filesystem usage", + "description": "Bytes per Second", + "definition": { + "lineChart": { + "legend": { + "isVisible": true, + "columns": [], + "groupByQuery": true, + "placement": "LEGEND_PLACEMENT_AUTO" + }, + "tooltip": { + "showLabels": false, + "type": "TOOLTIP_TYPE_ALL" + }, + "queryDefinitions": [ + { + "id": "83572569-8df6-476b-f60c-868fdfcda370", + "query": { + "metrics": { + "promqlQuery": { + "value": "sum(k8s_pod_filesystem_usage_By{k8s_pod_name=~\"coralogix-opentelemetry.*\"}) by (k8s_pod_name)" + }, + "filters": [], + "editorMode": "METRICS_QUERY_EDITOR_MODE_TEXT" + } + }, + "seriesCountLimit": "20", + "unit": "UNIT_BYTES_IEC", + "scaleType": "SCALE_TYPE_LINEAR", + "name": "Logs", + "isVisible": true, + "colorScheme": "classic", + "resolution": { + "bucketsPresented": 96 + }, + "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED", + "customUnit": "" + } + ], + "stackedLine": "STACKED_LINE_UNSPECIFIED" + } + } + } + ] + } + ], + "options": { + "custom": { + "name": " System stats", + "collapsed": false, + "color": { + "predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED" + } + } + } + } + ] + }, + "variables": [], + "filters": [ + { + "source": { + "metrics": { + "label": "cx_subsystem_name", + "operator": { + "equals": { + "selection": { + "list": { + "values": [] + } + } + } + } + } + }, + "enabled": true, + "collapsed": false + }, + { + "source": { + "metrics": { + "label": "k8s_cluster_name", + "operator": { + "equals": { + "selection": { + "all": {} + } + } + } + } + }, + "enabled": true, + "collapsed": false + }, + { + "source": { + "metrics": { + "label": "k8s_pod_name", + "operator": { + "equals": { + "selection": { + "list": { + "values": [] + } + } + } + } + } + }, + "enabled": true, + "collapsed": false + } + ], + "relativeTimeFrame": "300s", + "annotations": [], + "off": {} + } \ No newline at end of file diff --git a/examples/resources/coralogix_dashboard/resource.tf b/examples/resources/coralogix_dashboard/resource.tf new file mode 100644 index 00000000..f7f7ce1d --- /dev/null +++ b/examples/resources/coralogix_dashboard/resource.tf @@ -0,0 +1,614 @@ +resource "coralogix_dashboard" dashboard { + name = "portal monitoring" + description = "" + layout = { + sections = [ + { + options = { + name = "Status" + description = "abc" + collapsed = false + color = "blue" + } + rows = [ + { + height = 15 + widgets = [ + { + title = "Avg api response times" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "kubernetes.namespace_name:\"portal\" AND kubernetes.pod_name.keyword:/api-deployment.*/ AND message:\"HTTP\" AND NOT \"OPTIONS\" AND NOT \"metrics\" AND NOT \"firebase\"" + aggregations = [ + { + type = "avg" + field = "meta.responseTime.numeric" + }, + ] + group_by = [ + "meta.organization.keyword" + ] + } + } + scale_type = "linear" + series_count_limit = 100 + unit = "milliseconds" + resolution = { + interval = "seconds:900" + } + }, + ] + legend = { + is_visible = true + columns = ["avg", "max"] + } + tooltip = { + show_labels = false + type = "all" + } + } + } + }, + { + title = "Avg Snowflake query times" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "kubernetes.namespace_name:\"portal\" AND \"Successfully executed\"" + aggregations = [ + { + type = "percentile" + field = "sfResponseTime.numeric" + percent = 95.5 + }, + ] + group_by = [ + "sfDatabase.keyword" + ] + } + } + scale_type = "linear" + series_count_limit = 100 + unit = "milliseconds" + }, + ] + legend = { + is_visible = true + columns = ["avg"] + } + tooltip = { + show_labels = false + type = "all" + } + } + } + }, + { + title = "Avg RDS query times" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "kubernetes.namespace_name:\"portal\" AND kubernetes.pod_name.keyword:/api-deployment.*/ AND \"Postgres successfully\"" + aggregations = [ + { + type = "avg" + field = "RDSResponseTime.numeric" + }, + ] + group_by = [ + "RDSDatabase.keyword" + ] + } + } + scale_type = "linear" + series_count_limit = 100 + unit = "milliseconds" + resolution = { + buckets_presented = 10 + } + }, + ] + legend = { + is_visible = true + columns = ["avg"] + } + tooltip = { + show_labels = false + type = "all" + } + } + } + width = 10 + }, + ] + }, + { + height = 15 + widgets = [ + { + title = "OpenAPI - Avg response times" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "kubernetes.namespace_name:\"portal\" AND kubernetes.pod_name.keyword:/openapi-deployment.*/ AND message:\"HTTP\" AND NOT \"OPTIONS\" AND NOT \"metrics\" AND NOT \"firebase\"" + aggregations = [ + { + type = "avg" + field = "meta.responseTime.numeric" + }, + ] + group_by = [ + "meta.organization.keyword" + ] + } + } + scale_type = "linear" + series_count_limit = 100 + unit = "milliseconds" + }, + ] + legend = { + is_visible = true + columns = ["avg", "max"] + } + tooltip = { + show_labels = false + type = "all" + } + } + } + width = 10 + }, + { + title = "gauge" + definition = { + gauge = { + unit = "milliseconds" + query = { + metrics = { + promql_query = "vector(1)" + aggregation = "unspecified" + } + } + } + } + } + ] + }, + { + height = 15 + widgets = [ + { + title = "Open API Requests per organization" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "kubernetes.namespace_name:\"portal\" AND (service:\"api.eu.name.ai-production\" OR service:\"api.us.name.ai-production\")" + aggregations = [ + { + type = "count" + }, + ] + group_by = [ + "meta.organization.keyword" + ] + } + } + scale_type = "linear" + series_count_limit = 100 + }, + ] + legend = { + is_visible = true + } + tooltip = { + show_labels = false + type = "all" + } + } + } + width = 0 + }, + { + title = "Last failed SF queries DBs" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "kubernetes.namespace_name:\"portal\" AND \"Failed to execute statement\"" + aggregations = [ + { + type = "count" + } + ] + group_by = [ + "sfDatabase.keyword" + ] + } + } + scale_type = "linear" + series_count_limit = 100 + }, + ] + legend = { + is_visible = true + } + tooltip = { + show_labels = false + type = "all" + } + } + } + width = 0 + }, + { + title = "Avg configuration service query times" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "kubernetes.namespace_name:\"portal\" AND kubernetes.pod_name.keyword:/api-deployment.*/ AND \"Configuration Service request\"" + aggregations = [ + { + type = "avg" + field = "configResponseTime.numeric" + }, + ] + } + } + scale_type = "linear" + series_count_limit = 100 + }, + ] + legend = { + is_visible = false + } + tooltip = { + show_labels = false + type = "all" + } + } + } + }, + ] + height = 15 + }, + { + height = 19 + widgets = [ + { + title = "Slowest API requests" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = " kubernetes.namespace_name:\"portal\" AND kubernetes.pod_name.keyword:/api-deployment.*/ AND message:\"http\"" + aggregations = [ + { + type = "max" + field = "meta.responseTime.numeric" + }, + ] + group_by = [ + "meta.req.url.keyword" + ] + } + } + scale_type = "linear" + series_count_limit = 10 + unit = "milliseconds" + }, + ] + legend = { + is_visible = true + columns = ["max"] + } + tooltip = { + show_labels = false + type = "all" + } + } + } + }, + ] + }, + { + height = 19 + widgets = [ + { + title = "Cache warmer runs" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "kubernetes.namespace_name:\"portal\" AND kubernetes.container_name:\"portal-cache-warmer\" AND message:\"Finish cache warmer run successfully\"" + aggregations = [ + { + type = "count" + }, + ] + } + } + scale_type = "linear" + series_count_limit = 20 + }, + ] + legend = { + is_visible = true + } + tooltip = { + show_labels = false + type = "all" + } + } + } + }, + { + title = "Alerts notification eu runs" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "service:\"portal-eu-notify-alerts-production\" AND \"Finished notify new alerts\"" + aggregations = [ + { + type = "count" + }, + ] + } + } + scale_type = "linear" + series_count_limit = 20 + }, + ] + legend = { + is_visible = true + } + tooltip = { + show_labels = false + type = "all" + } + } + } + }, + { + title = "Alerts notification runs" + definition = { + line_chart = { + query_definitions = [ + { + query = { + logs = { + lucene_query = "service:\"portal-notify-alerts-production\" AND \"Finished notify new alerts\"" + aggregations = [ + { + type = "count" + }, + ] + } + } + }, + ] + scale_type = "linear" + series_count_limit = 20 + } + legend = { + is_visible = true + } + tooltip = { + show_labels = false + type = "all" + } + } + }, + { + title = "Alerts notification us runs" + definition = { + pie_chart = { + query = { + logs = { + lucene_query = "service:\"portal-us-notify-alerts-production\" AND \"Finished notify new alerts\"" + aggregation = { + type = "count" + } + group_names = [ + "service.keyword" + ] + } + } + label_definition = { + } + } + } + }, + { + title = "Alerts notification us runs" + definition = { + bar_chart = { + query = { + logs = { + lucene_query = "service:\"portal-us-notify-alerts-production\" AND \"Finished notify new alerts\"" + aggregation = { + type = "count" + } + group_names_fields = [ + { + keypath = ["logid"] + scope = "metadata" + }, + ] + stacked_group_name_field = { + keypath = ["logid"] + scope = "metadata" + } + } + } + xaxis = { + time = { + interval = "1h0m5s" + buckets_presented = 10 + } + } + } + } + }, + { + title = "Horizontal Bar-Chart" + definition = { + horizontal_bar_chart = { + color_scheme = "cold" + colors_by = "aggregation" + display_on_bar = true + query = { + logs = { + lucene_query = "service:\"portal-us-notify-alerts-production\" AND \"Finished notify new alerts\"" + aggregation = { + type = "count" + } + group_names = ["coralogix.logId.keyword"] + stacked_group_name = "coralogix.metadata.severity" + } + } + y_axis_view_by = "value" + } + } + }, + { + definition = { + markdown = { + markdown_text = "## Markdown\n\nThis is a markdown widget" + tooltip_text = "This is a tooltip" + } + } + }, + { + title = "Data Table" + definition = { + data_table = { + results_per_page = 10 + row_style = "one_line" + query = { + data_prime = { + query = "xxx" + filters = [ + { + logs = { + lucene_query = "service:\"portal-us-notify-alerts-production\" AND \"Finished notify new alerts\"" + aggregation = { + type = "count" + } + group_names = ["coralogix.logId.keyword"] + stacked_group_name = "coralogix.metadata.severity" + field = "coralogix.metadata.applicationName" + operator = { + type = "equals" + selected_values = ["staging"] + } + } + }, + ] + } + } + } + } + }, + ] + }, + ] + }, + ] + } + variables = [ + { + name = "test_variable" + display_name = "Test Variable" + definition = { + multi_select = { + selected_values = ["1", "2", "3"] + source = { + query ={ + query = { + metrics = { + metric_name = { + metric_regex = "vector(1)" + } + } + } + } + } + values_order_direction = "asc" + } + } + }, + ] + filters = [ + { + source = { + metrics = { + metric_name = "http_requests_total" + label = "status" + field = "coralogix.metadata.applicationName" + operator = { + type = "equals" + selected_values = ["staging"] + } + } + } + }, + ] + annotations = [ + { + name = "test_annotation" + source = { + metrics = { + promql_query = "vector(1)" + strategy = { + start_time = {} + } + message_template = "test annotation" + labels = ["test"] + } + } + }, + ] + auto_refresh = { + type = "two_minutes" + } + folder = { + id = coralogix_dashboards_folder.example.id + } +} + +resource "coralogix_dashboards_folder" "example" { + name = "example" +} + +resource "coralogix_dashboard" dashboard_from_json { + content_json = file("./dashboard.json") +} \ No newline at end of file From fd56938d67e251a4f56a22d7a77d4935e6db3d03 Mon Sep 17 00:00:00 2001 From: Claus Matzinger Date: Fri, 8 Nov 2024 11:04:50 +0100 Subject: [PATCH 6/7] ci: added a docs render job --- .github/workflows/render-docs.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/workflows/render-docs.yml diff --git a/.github/workflows/render-docs.yml b/.github/workflows/render-docs.yml new file mode 100644 index 00000000..91ea7e78 --- /dev/null +++ b/.github/workflows/render-docs.yml @@ -0,0 +1,17 @@ +name: Generate terraform docs +on: + - pull_request + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.ref }} + + - name: Render terraform docs and push changes back to PR + uses: terraform-docs/gh-actions@main + with: + working-dir: . + git-push: "true" \ No newline at end of file From 71d49215d993e0e6edc2c665c11bc0c3984b61ef Mon Sep 17 00:00:00 2001 From: Luigi Taglialatela Date: Mon, 11 Nov 2024 15:51:21 +0100 Subject: [PATCH 7/7] Change dashboard test json path --- .github/workflows/render-docs.yml | 17 ----------------- coralogix/resource_coralogix_dashboard_test.go | 8 ++++---- 2 files changed, 4 insertions(+), 21 deletions(-) delete mode 100644 .github/workflows/render-docs.yml diff --git a/.github/workflows/render-docs.yml b/.github/workflows/render-docs.yml deleted file mode 100644 index 91ea7e78..00000000 --- a/.github/workflows/render-docs.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Generate terraform docs -on: - - pull_request - -jobs: - docs: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - ref: ${{ github.event.pull_request.head.ref }} - - - name: Render terraform docs and push changes back to PR - uses: terraform-docs/gh-actions@main - with: - working-dir: . - git-push: "true" \ No newline at end of file diff --git a/coralogix/resource_coralogix_dashboard_test.go b/coralogix/resource_coralogix_dashboard_test.go index 9b970915..a797a997 100644 --- a/coralogix/resource_coralogix_dashboard_test.go +++ b/coralogix/resource_coralogix_dashboard_test.go @@ -1,11 +1,11 @@ // Copyright 2024 Coralogix Ltd. -// +// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at -// +// // https://www.apache.org/licenses/LICENSE-2.0 -// +// // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -113,7 +113,7 @@ func TestAccCoralogixResourceDashboardFromJson(t *testing.T) { panic(err) } parent := filepath.Dir(wd) - filePath := parent + "/examples/dashboard/dashboard.json" + filePath := parent + "/examples/resources/coralogix_hosted_dashboard/grafana_acc_updated_dashboard.json" resource.Test(t, resource.TestCase{ PreCheck: func() { testAccPreCheck(t) }, ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,