Skip to content

Commit

Permalink
doc: add possible values
Browse files Browse the repository at this point in the history
Add possible values to mezmo_filter_processor and operator attribute
until hashicorp/terraform-plugin-docs#243 is
fixed. This tells the user which values are accepted in the docs.

Ref: LOG-19859
  • Loading branch information
martinohansen committed May 13, 2024
1 parent 21f65eb commit e6594e8
Show file tree
Hide file tree
Showing 48 changed files with 1,974 additions and 64 deletions.
32 changes: 32 additions & 0 deletions docs/resources/agent_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,39 @@ description: |-

Represents a Mezmo agent source.

## Example Usage

```terraform
terraform {
required_providers {
mezmo = {
source = "registry.terraform.io/mezmo/mezmo"
}
}
required_version = ">= 1.1.0"
}
provider "mezmo" {
auth_key = "my secret"
}
resource "mezmo_pipeline" "pipeline1" {
title = "My pipeline"
}
resource "mezmo_agent_source" "source1" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My agent source"
description = "This receives data from my webhook"
}
resource "mezmo_agent_source" "shared_source" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "A shared agent source"
description = "This source uses the same data as source1"
gateway_route_id = mezmo_agent_source.source1.gateway_route_id
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
74 changes: 66 additions & 8 deletions docs/resources/aggregate_v2_processor.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,65 @@ description: |-

Aggregates multiple metric events into a single metric event using either a tumbling interval window or a sliding interval window


## Example Usage

```terraform
terraform {
required_providers {
mezmo = {
source = "registry.terraform.io/mezmo/mezmo"
}
}
required_version = ">= 1.1.0"
}
provider "mezmo" {
auth_key = "my secret"
}
resource "mezmo_pipeline" "pipeline1" {
title = "My pipeline"
}
resource "mezmo_http_source" "curl" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My data stream"
description = "Send Curl data to the pipeline point of entry URL"
decoding = "json"
}
resource "mezmo_aggregate_v2_processor" "processor1" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My aggregate v2 processor"
description = "Aggregate my metrics via tumbling window"
window_type = "tumbling"
interval = 3600
}
resource "mezmo_aggregate_v2_processor" "processor2" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My aggregate v2 processor"
description = "Aggregate my metrics via sliding window"
window_type = "sliding"
interval = 3600
operation = "average"
conditional = {
expressions = [
{
field = ".tags.host"
operator = "contains"
value_string = "internal"
},
{
field = ".tags.app"
operator = "contains"
value_string = "my_app"
}
]
logical_operation = "OR"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down Expand Up @@ -53,7 +111,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: contains, ends_with, equal, exists, greater, greater_or_equal, is_array, is_boolean, is_empty, is_ip_in_cidr_range, is_metric, is_null, is_number, is_object, is_string, less, less_or_equal, not_contains, not_equal, not_exists, not_regex_match, regex_match or starts_with.

Optional:

Expand All @@ -76,7 +134,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: contains, ends_with, equal, exists, greater, greater_or_equal, is_array, is_boolean, is_empty, is_ip_in_cidr_range, is_metric, is_null, is_number, is_object, is_string, less, less_or_equal, not_contains, not_equal, not_exists, not_regex_match, regex_match or starts_with.

Optional:

Expand All @@ -99,7 +157,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: contains, ends_with, equal, exists, greater, greater_or_equal, is_array, is_boolean, is_empty, is_ip_in_cidr_range, is_metric, is_null, is_number, is_object, is_string, less, less_or_equal, not_contains, not_equal, not_exists, not_regex_match, regex_match or starts_with.

Optional:

Expand All @@ -122,7 +180,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: contains, ends_with, equal, exists, greater, greater_or_equal, is_array, is_boolean, is_empty, is_ip_in_cidr_range, is_metric, is_null, is_number, is_object, is_string, less, less_or_equal, not_contains, not_equal, not_exists, not_regex_match, regex_match or starts_with.

Optional:

Expand All @@ -145,7 +203,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: contains, ends_with, equal, exists, greater, greater_or_equal, is_array, is_boolean, is_empty, is_ip_in_cidr_range, is_metric, is_null, is_number, is_object, is_string, less, less_or_equal, not_contains, not_equal, not_exists, not_regex_match, regex_match or starts_with.

Optional:

Expand All @@ -168,7 +226,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: contains, ends_with, equal, exists, greater, greater_or_equal, is_array, is_boolean, is_empty, is_ip_in_cidr_range, is_metric, is_null, is_number, is_object, is_string, less, less_or_equal, not_contains, not_equal, not_exists, not_regex_match, regex_match or starts_with.

Optional:

Expand All @@ -190,7 +248,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: contains, ends_with, equal, exists, greater, greater_or_equal, is_array, is_boolean, is_empty, is_ip_in_cidr_range, is_metric, is_null, is_number, is_object, is_string, less, less_or_equal, not_contains, not_equal, not_exists, not_regex_match, regex_match or starts_with.

Optional:

Expand Down
36 changes: 36 additions & 0 deletions docs/resources/azure_blob_storage_destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,43 @@ description: |-

Publishes events to Azure Blob Storage

## Example Usage

```terraform
terraform {
required_providers {
mezmo = {
source = "registry.terraform.io/mezmo/mezmo"
}
}
required_version = ">= 1.1.0"
}
provider "mezmo" {
auth_key = "my secret"
}
resource "mezmo_pipeline" "pipeline1" {
title = "My pipeline"
}
resource "mezmo_demo_source" "source1" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My source"
description = "This is the point of entry for our data"
format = "nginx"
}
resource "mezmo_azure_blob_storage_destination" "destination1" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My destination"
description = "Send logs to Azure Blob Storage"
inputs = [mezmo_demo_source.source1.id]
connection_string = "AccountName=mylogstorage;AccountKey=storageaccountkeybase64encoded;EndpointSuffix=core.windows.net"
container_name = "my-logs"
compression = "gzip"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
34 changes: 34 additions & 0 deletions docs/resources/blackhole_destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,41 @@ description: |-

Represents a blackhole destination.

## Example Usage

```terraform
terraform {
required_providers {
mezmo = {
source = "registry.terraform.io/mezmo/mezmo"
}
}
required_version = ">= 1.1.0"
}
provider "mezmo" {
auth_key = "my secret"
}
resource "mezmo_pipeline" "pipeline1" {
title = "My pipeline"
}
resource "mezmo_demo_source" "source1" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My source"
description = "This is the point of entry for our data"
format = "nginx"
}
resource "mezmo_blackhole_destination" "destination1" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My destination"
description = "Trash the data without acking"
ack_enabled = false
inputs = [mezmo_demo_source.source1.id]
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
14 changes: 7 additions & 7 deletions docs/resources/change_alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: percent_change_greater, percent_change_greater_or_equal, percent_change_less, percent_change_less_or_equal, value_change_greater, value_change_greater_or_equal, value_change_less or value_change_less_or_equal.

Optional:

Expand All @@ -140,7 +140,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: percent_change_greater, percent_change_greater_or_equal, percent_change_less, percent_change_less_or_equal, value_change_greater, value_change_greater_or_equal, value_change_less or value_change_less_or_equal.

Optional:

Expand All @@ -163,7 +163,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: percent_change_greater, percent_change_greater_or_equal, percent_change_less, percent_change_less_or_equal, value_change_greater, value_change_greater_or_equal, value_change_less or value_change_less_or_equal.

Optional:

Expand All @@ -186,7 +186,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: percent_change_greater, percent_change_greater_or_equal, percent_change_less, percent_change_less_or_equal, value_change_greater, value_change_greater_or_equal, value_change_less or value_change_less_or_equal.

Optional:

Expand All @@ -209,7 +209,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: percent_change_greater, percent_change_greater_or_equal, percent_change_less, percent_change_less_or_equal, value_change_greater, value_change_greater_or_equal, value_change_less or value_change_less_or_equal.

Optional:

Expand All @@ -232,7 +232,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: percent_change_greater, percent_change_greater_or_equal, percent_change_less, percent_change_less_or_equal, value_change_greater, value_change_greater_or_equal, value_change_less or value_change_less_or_equal.

Optional:

Expand All @@ -254,7 +254,7 @@ Optional:
Required:

- `field` (String) The field path whose value will be used in the comparison
- `operator` (String) The comparison operator
- `operator` (String) The comparison operator. Possible values are: percent_change_greater, percent_change_greater_or_equal, percent_change_less, percent_change_less_or_equal, value_change_greater, value_change_greater_or_equal, value_change_less or value_change_less_or_equal.

Optional:

Expand Down
34 changes: 34 additions & 0 deletions docs/resources/compact_fields_processor.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,41 @@ description: |-

Remove empty values from a list of fields

## Example Usage

```terraform
terraform {
required_providers {
mezmo = {
source = "registry.terraform.io/mezmo/mezmo"
}
}
required_version = ">= 1.1.0"
}
provider "mezmo" {
auth_key = "my secret"
}
resource "mezmo_pipeline" "pipeline1" {
title = "My pipeline"
}
resource "mezmo_http_source" "curl" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My data stream"
description = "Send Curl data to the pipeline point of entry URL"
decoding = "json"
}
resource "mezmo_compact_fields_processor" "processor1" {
pipeline_id = mezmo_pipeline.pipeline1.id
title = "My compact fields processor"
description = "Get those null values outta here!"
inputs = [mezmo_http_source.curl.id]
fields = [".root_level_field", ".nested.field"]
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
Loading

0 comments on commit e6594e8

Please sign in to comment.