Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the actual cloud.provider example. #348

Merged
merged 1 commit into from
Mar 5, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix the actual cloud.provider example.
PR #330 only fixed the text in the description :-)
  • Loading branch information
Mathieu Martin committed Mar 4, 2019
commit 91f921f9c07c0da5d44ce89276f86d859943a727
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -136,7 +136,7 @@ Fields related to the cloud or infrastructure the events are coming from.

| Field | Description | Level | Type | Example |
|---|---|---|---|---|
| <a name="cloud.provider"></a>cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | extended | keyword | `ec2` |
| <a name="cloud.provider"></a>cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | extended | keyword | `aws` |
| <a name="cloud.availability_zone"></a>cloud.availability_zone | Availability zone in which this host is running. | extended | keyword | `us-east-1c` |
| <a name="cloud.region"></a>cloud.region | Region in which this host is running. | extended | keyword | `us-east-1` |
| <a name="cloud.instance.id"></a>cloud.instance.id | Instance ID of the host machine. | extended | keyword | `i-1234567890abcdef0` |
2 changes: 1 addition & 1 deletion fields.yml
Original file line number Diff line number Diff line change
@@ -222,7 +222,7 @@
fields:
- name: provider
level: extended
example: ec2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The implementation in Beats populates this with ec2. It would be helpful to have a list of names in ECS to use for popular providers. Ironically one of the providers is using ecs. https://github.com/elastic/beats/blob/master/libbeat/docs/processors-using.asciidoc#add-cloud-metadata

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the document example is better using "aws" but there could be a case for using service.name in cloud-provider relevant events to capture the service such as "ec2." Agree we could expand the list of examples to eventually become a set of defined names.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed on the enums. However they will come after 1.0 :-)

example: aws
type: keyword
short: Name of the cloud provider.
description: >
2 changes: 1 addition & 1 deletion generated/csv/fields.csv
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ cloud.availability_zone,keyword,extended,us-east-1c,1.1.0-dev
cloud.instance.id,keyword,extended,i-1234567890abcdef0,1.1.0-dev
cloud.instance.name,keyword,extended,,1.1.0-dev
cloud.machine.type,keyword,extended,t2.medium,1.1.0-dev
cloud.provider,keyword,extended,ec2,1.1.0-dev
cloud.provider,keyword,extended,aws,1.1.0-dev
cloud.region,keyword,extended,us-east-1,1.1.0-dev
container.id,keyword,core,,1.1.0-dev
container.image.name,keyword,extended,,1.1.0-dev
2 changes: 1 addition & 1 deletion generated/ecs/fields_flat.yml
Original file line number Diff line number Diff line change
@@ -321,7 +321,7 @@ cloud.machine.type:
cloud.provider:
description: Name of the cloud provider. Example values are aws, azure, gcp, or
digitalocean.
example: ec2
example: aws
flat_name: cloud.provider
ignore_above: 1024
level: extended
2 changes: 1 addition & 1 deletion generated/ecs/fields_nested.yml
Original file line number Diff line number Diff line change
@@ -282,7 +282,7 @@ cloud:
provider:
description: Name of the cloud provider. Example values are aws, azure, gcp,
or digitalocean.
example: ec2
example: aws
flat_name: cloud.provider
ignore_above: 1024
level: extended
2 changes: 1 addition & 1 deletion generated/legacy/schema.csv
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ cloud.availability_zone,keyword,extended,us-east-1c
cloud.instance.id,keyword,extended,i-1234567890abcdef0
cloud.instance.name,keyword,extended,
cloud.machine.type,keyword,extended,t2.medium
cloud.provider,keyword,extended,ec2
cloud.provider,keyword,extended,aws
cloud.region,keyword,extended,us-east-1
container.id,keyword,core,
container.image.name,keyword,extended,
2 changes: 1 addition & 1 deletion schema.json
Original file line number Diff line number Diff line change
@@ -241,7 +241,7 @@
},
"cloud.provider": {
"description": "Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.",
"example": "ec2",
"example": "aws",
"footnote": "",
"group": 2,
"level": "extended",
2 changes: 1 addition & 1 deletion schemas/cloud.yml
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@
fields:
- name: provider
level: extended
example: ec2
example: aws
type: keyword
short: Name of the cloud provider.
description: >