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

[DOCS] Add Kibana tutorial to ECS mapping docs #1772

Merged
merged 4 commits into from
Feb 22, 2022
Merged

[DOCS] Add Kibana tutorial to ECS mapping docs #1772

merged 4 commits into from
Feb 22, 2022

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Feb 11, 2022

elastic/kibana#101216 adds a new ECS mapper feature to Kibana's Ingest Pipelines UI. This updates the ECS docs to cover the new feature.

Preview

https://ecs_1772.docs-preview.app.elstc.co/guide/en/ecs/master/ecs-converting.html#ecs-map-custom-data-to-ecs-es-pipeline

@jrodewig jrodewig marked this pull request as ready for review February 11, 2022 17:31
@jrodewig jrodewig added 8.1.0 8.2.0 DOCS Any issue related to ECS documentation labels Feb 11, 2022
Copy link
Contributor

@kgeller kgeller left a comment

Choose a reason for hiding this comment

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

LGTM!

The only thing I am uncertain about, but I think @jamiehynds can answer: do we want to keep mention of 'ECS Mapper'?

If you prefer to use Beats or Logstash pipelines, you can also use the ECS Mapper to turn a CSV version of the spreadsheet into an equivalent Beats or Logstash pipeline.

@jrodewig
Copy link
Contributor Author

Thanks! It's worth noting that the spreadsheet template also mentions ECS Mapper:

https://docs.google.com/spreadsheets/d/1m5JiOTeZtUueW3VOVqS8bFYqNGEEyp0jAsgO12NFkNM/edit#gid=1064660240

It's outside the scope of this PR, but we probably want to update or remove that sheet.

After exporting your mapping spreadsheet to CSV, ECS Mapper will convert your field mapping
to equivalent pipelines for Beats, Elasticsearch, and Logstash. Learn more at
https://github.com/elastic/ecs-mapper[ECS Mapper].
If you prefer to use {beats} or {ls} pipelines, you can also use the
Copy link
Member

Choose a reason for hiding this comment

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

@kgeller @jamiehynds - I'm in favor of archiving ecs-mapper and indicating it's no longer maintained in the project's README. Unfortunately, the ECS team doesn't have the spare capacity to maintain or improve it right now.

If we archive the project, we can remove this reference from the docs.

Copy link
Contributor Author

@jrodewig jrodewig Feb 15, 2022

Choose a reason for hiding this comment

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

I pushed bfaff54 to remove the reference. That lets us decouple these docs from the archival of the ecs-mapper repo.

Copy link
Member

@ebeahan ebeahan left a comment

Choose a reason for hiding this comment

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

LGTM

With the reference removed, does that address your question in #1772 (review) @kgeller?

@kgeller
Copy link
Contributor

kgeller commented Feb 17, 2022

With the reference removed, does that address your question in #1772 (review) @kgeller?

Yes, it does!

@jrodewig
Copy link
Contributor Author

Thanks for the reviews!

@jrodewig jrodewig merged commit c3734cc into elastic:main Feb 22, 2022
@jrodewig jrodewig deleted the docs__add-ecs-mapper-kibana-tutorial branch February 22, 2022 17:42
@jrodewig
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.1

Questions ?

Please refer to the Backport tool documentation

jrodewig added a commit that referenced this pull request Feb 22, 2022
elastic/kibana#101216 adds a new ECS mapper feature to Kibana's Ingest Pipelines UI. This updates the ECS docs to cover the new feature.
(cherry picked from commit c3734cc)
ebeahan pushed a commit to ebeahan/ecs that referenced this pull request Feb 22, 2022
elastic/kibana#101216 adds a new ECS mapper feature to Kibana's Ingest Pipelines UI. This updates the ECS docs to cover the new feature.
(cherry picked from commit c3734cc)
@ebeahan
Copy link
Member

ebeahan commented Feb 22, 2022

💚 All backports created successfully

Status Branch Result
8.2

Questions ?

Please refer to the Backport tool documentation

ebeahan added a commit that referenced this pull request Feb 22, 2022
elastic/kibana#101216 adds a new ECS mapper feature to Kibana's Ingest Pipelines UI. This updates the ECS docs to cover the new feature.
(cherry picked from commit c3734cc)

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.1.0 8.2.0 DOCS Any issue related to ECS documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants