Skip to content

[Apache Tomcat] Add integration package with catalina data stream #5926

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

Merged

Conversation

niraj-elastic
Copy link
Contributor

@niraj-elastic niraj-elastic commented Apr 19, 2023

  • Enhancement

What does this PR do?

  • Added 1 data stream (Catalina logs).
  • Added data collection logic for the data streams.
  • Added the ingest pipeline for the data streams.
  • Mapped fields according to the ECS schema and added Fields metadata in the appropriate yaml files.
  • Added dashboards and visualizations.
  • Added system test cases for the data stream.

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.

How to test this PR locally

  • Clone integrations repo.
  • Install elastic-package locally.
  • Start elastic stack using elastic-package.
  • Move to integrations/packages/tomcat) directory.
  • Run the following command to run tests. elastic-package test

Screenshots

apache_tomcat-catalina-localhost-dashboard

Meta issue

Related PRs

@niraj-elastic niraj-elastic requested a review from a team as a code owner April 19, 2023 16:28
@elasticmachine
Copy link

elasticmachine commented Apr 19, 2023

💚 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-05-05T16:55:12.417+0000

  • Duration: 15 min 54 sec

Test stats 🧪

Test Results
Failed 0
Passed 8
Skipped 0
Total 8

🤖 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 Apr 19, 2023

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (1/1) 💚
Files 100.0% (1/1) 💚
Classes 100.0% (1/1) 💚
Methods 90.909% (10/11) 👎 -5.245
Lines 88.889% (80/90) 👎 -11.111
Conditionals 100.0% (0/0) 💚

@kush-elastic kush-elastic requested a review from ishleenk17 April 20, 2023 05:17
@kush-elastic kush-elastic added enhancement New feature or request Integration:apache_tomcat Apache Tomcat v8.7.0 Team:Service-Integrations Label for the Observability Service Integrations team labels Apr 20, 2023
@kush-elastic kush-elastic self-requested a review April 20, 2023 05:19
Copy link
Contributor

@harnish-crest-data harnish-crest-data left a comment

Choose a reason for hiding this comment

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

LGTM!

@@ -0,0 +1,173 @@
================================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
Copy link
Member

Choose a reason for hiding this comment

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

This release note looks to be quite detailed. Is there a need for this ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we can skip it.

Copy link
Member

Choose a reason for hiding this comment

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

Or we can shorten it to keep just the important information.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don't think we require it. let us know your thoughts over it.

Copy link
Member

Choose a reason for hiding this comment

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

Lets remove this then

@ishleenk17 ishleenk17 requested a review from a team May 1, 2023 07:32
@niraj-elastic
Copy link
Contributor Author

@ishleenk17 currently we are facing one issue with timestamp in which we see logs in incorrect time window in kibana discover page. We are looking in to it and fix it soon.

@ishleenk17
Copy link
Member

@niraj-elastic : The sample logs files under deploy/docker are same for all the 3 log datastreams.
These should be as per the actual access, localhost, and catalina logs.

@niraj-elastic
Copy link
Contributor Author

@niraj-elastic : The sample logs files under deploy/docker are same for all the 3 log datastreams. These should be as per the actual access, localhost, and catalina logs.

@ishleenk17 We are able to generate log files of access and catalina in docker itself, but we are not able to generate log file of localhost. so we only have to add localhost file in sample logs.

@ishleenk17
Copy link
Member

@ishleenk17 currently we are facing one issue with timestamp in which we see logs in incorrect time window in kibana discover page. We are looking in to it and fix it soon.

Please mention this issue and its details in the Meta Issue for tracking

dependencies:
ecs:
reference: git@v8.7.0
import_mappings: true
Copy link
Member

Choose a reason for hiding this comment

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

We are using import_mappings and having ecs.yml file as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

@ishleenk17 Could you please refer to this comment? Let me know if you have still any doubts regarding this!

Copy link
Member

Choose a reason for hiding this comment

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

For log datastreams, there is no TSDB to be enabled. So that won't hold true here?
Is the purpose to keep then in README?

Copy link
Member

Choose a reason for hiding this comment

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

User can see these fields from the sample event

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ishleenk17 Yes, if we dont mention these fields in ecs.yml than these fields wont be reflected in readme. So for better user experience we are keeping this fields in ecs.yml.

Copy link
Member

@ishleenk17 ishleenk17 left a comment

Choose a reason for hiding this comment

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

Looks good!

@kush-elastic kush-elastic merged commit 707ba7c into elastic:main May 8, 2023
@elasticmachine
Copy link

Package apache_tomcat - 0.1.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
Labels
enhancement New feature or request Integration:apache_tomcat Apache Tomcat New Integration Issue or pull request for creating a new integration package. Team:Service-Integrations Label for the Observability Service Integrations team v8.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants