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.

Sign up for GitHub

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

Jump to bottom

[O11y][Apache Tomcat] Add TSDB enablement for request and cache data streams and update ecs.yml file #6788

Merged
merged 8 commits into from Oct 18, 2023
Merged

[O11y][Apache Tomcat] Add TSDB enablement for request and cache data streams and update ecs.yml file #6788

merged 8 commits into from Oct 18, 2023

Conversation

harnish-elastic
Copy link
Contributor

@harnish-elastic harnish-elastic commented Jul 3, 2023 •
edited

Urgency

  • Normal

Activity Type

  • Enhancement

What does this PR do?

  • Add TSDB enablement for the Apache Tomcat request and cache metrics data streams
  • Update ecs.yml file for Apache Tomcat request, cache and session data streams
  • Update the Kibana version from 8.7.0 to 8.8.0

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Meta issue

Related issue

Screenshots after enabling TSDB

Session: apache_tomcat-session-dashboard

Cache: apache_tomcat-cache-dashboard

Request: apache_tomcat-request-dashboard

@harnish-elastic harnish-elastic self-assigned this Jul 3, 2023
@harnish-elastic harnish-elastic mentioned this pull request Jul 3, 2023
Closed
18 tasks
@elasticmachine
Copy link

elasticmachine commented Jul 3, 2023 •
edited

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-10-13T05:49:13.750+0000

  • Duration: 25 min 3 sec

Test stats 🧪

Test Results
Failed 0
Passed 54
Skipped 0
Total 54

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

elasticmachine commented Jul 3, 2023 •
edited

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (9/9) 💚
Files 100.0% (9/9) 💚
Classes 100.0% (9/9) 💚
Methods 95.062% (77/81) 👍 20.062
Lines 79.897% (934/1169) 👎 -20.103
Conditionals 100.0% (0/0) 💚

@harnish-elastic harnish-elastic marked this pull request as ready for review July 3, 2023 12:38
@harnish-elastic harnish-elastic requested a review from a team as a code owner July 3, 2023 12:38
@lalit-satapathy
Copy link
Collaborator

Please details on TSDB specific testing done.

Also it is a beta package, Let's discuss TSDB enablement plan for it.

@aliabbas-elastic
Copy link
Contributor

aliabbas-elastic commented Jul 4, 2023 •
edited

Please details on TSDB specific testing done.

Here are the summaries of test cases that are executed on all the metrics data streams for Apache Tomcat.

  • Verify data collection is working after the toggle for TSDB is enabled and there should be no data loss
  • Verify there are no conflicting fields present in the TSDB enabled data stream
  • Verify the index mode setting should be set to time_series in the Index Template of the data stream after TSDB is enabled
  • Verify by populating all the visualizations after starting the data collection in TSDB mode and there are no errors while any of the visualization loads
  • Verify that the value of dimension limit on fields is not exceeded ( default is 16 )
  • Verify certain fields like host.name, service.address, agent.id, cloud.project.id, cloud.instance.id, cloud.provider, container.id are set as dimension fields ( as per mentioned in the documentation guidelines )
  • Verify by upgrading the existing apache_tomcat package to TSDB enabled package and making sure that the data collection is working as expected without any data loss ( also check populating the visualizations as well in the latest package )
  • Verify all fields which are set as dimension must be set with type of field as keyword
  • Verify that dimension is not set to true on multi valued fields (e.g., array)

For more detailed scenarios, I have the shared the test plan with you.

@harnish-elastic
address review comments for re-generate system test
c29d2af
@harnish-elastic
Merge branch 'main' of https://github.com/harnish-elastic/integrations …
101af08 
…into package-apache_tomcat-add-tsdb-enablement

Conflicts:
	packages/apache_tomcat/changelog.yml
kush-elastic
kush-elastic approved these changes Jul 10, 2023
View reviewed changes
Copy link
Collaborator

@kush-elastic kush-elastic left a comment

Choose a reason for hiding this comment

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

LGTM!

@harnish-elastic harnish-elastic changed the title [O11y][Apache Tomcat] Add TSDB enablement for request and cache data streams [O11y][Apache Tomcat] Add TSDB enablement for request and cache data streams and update ecs.yml file Jul 12, 2023
@harnish-elastic
Merge branch 'main' of https://github.com/harnish-elastic/integrations …
ea31a34 
…into package-apache_tomcat-add-tsdb-enablement

Conflicts:
	packages/apache_tomcat/changelog.yml
agithomas
agithomas approved these changes Jul 14, 2023
View reviewed changes
Copy link
Contributor

@agithomas agithomas left a comment

Choose a reason for hiding this comment

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

LGTM!

Adding @lalit-satapathy as an additional reviewer

@harnish-elastic harnish-elastic mentioned this pull request Jul 24, 2023
Closed
17 tasks
@botelastic
Copy link

botelastic bot commented Aug 19, 2023

Hi! We just realized that we haven't looked into this PR in a while. We're sorry! We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!

@botelastic botelastic bot added the Stalled label Aug 19, 2023
@botelastic
Copy link

botelastic bot commented Sep 18, 2023

Hi! This PR has been stale for a while and we're going to close it as part of our cleanup procedure. We appreciate your contribution and would like to apologize if we have not been able to review it, due to the current heavy load of the team. Feel free to re-open this PR if you think it should stay open and is worth rebasing. Thank you for your contribution!

@botelastic botelastic bot closed this Sep 18, 2023
@botelastic botelastic bot removed the Stalled label Sep 18, 2023
@harnish-elastic
Merge branch 'main' of https://github.com/harnish-elastic/integrations …
9f5752b 
…into package-apache_tomcat-add-tsdb-enablement

Conflicts:
	packages/apache_tomcat/changelog.yml
	packages/apache_tomcat/data_stream/cache/sample_event.json
	packages/apache_tomcat/data_stream/request/sample_event.json
	packages/apache_tomcat/docs/README.md
	packages/apache_tomcat/manifest.yml
@lalit-satapathy
Copy link
Collaborator

lalit-satapathy commented Oct 17, 2023 •
edited

We can proceed on this, if all latest TSDB testing has been done. This is a beta integration currently.

@harnish-elastic harnish-elastic merged commit ffe9c35 into elastic:main Oct 18, 2023
4 checks passed
@elasticmachine
Copy link

Package apache_tomcat - 0.15.0 containing this change is available at https://epr.elastic.co/search?package=apache_tomcat

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kush-elastic kush-elastic kush-elastic approved these changes

@agithomas agithomas agithomas approved these changes

@milan-elastic milan-elastic Awaiting requested review from milan-elastic

@lalit-satapathy lalit-satapathy Awaiting requested review from lalit-satapathy

Assignees

@harnish-elastic harnish-elastic

Labels
enhancement New feature or request Integration:Tomcat v8.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[O11y][Apache Tomcat] TSDB Enablement
6 participants
@harnish-elastic @elasticmachine @lalit-satapathy @aliabbas-elastic @kush-elastic @agithomas