Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

[Citrix ADC] Add Integration Package with Service Data Stream #4364

Merged
merged 10 commits into from
Nov 22, 2022
Merged

[Citrix ADC] Add Integration Package with Service Data Stream #4364

merged 10 commits into from
Nov 22, 2022

Conversation

harnish-crest
Copy link
Contributor

@harnish-crest harnish-crest commented Oct 3, 2022 •
edited
Loading

  • Enhancement

What does this PR do?

  • Added 1 data stream (Service metrics).
  • 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/citrix_adc directory.
  • Run the following command to run tests.
    elastic-package test

Related issues

Screenshots

citrix_adc-overview-dashboard
new-service-dashboard

@harnish-crest harnish-crest marked this pull request as draft October 3, 2022 12:56
@elasticmachine
Copy link

elasticmachine commented Oct 3, 2022 •
edited
Loading

💚 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: 2022-11-09T06:00:55.682+0000

  • Duration: 15 min 2 sec

Test stats 🧪

Test Results
Failed 0
Passed 13
Skipped 0
Total 13

🤖 GitHub comments

Expand to view the GitHub comments

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

  • /test : Re-trigger the build.

@harnish-crest harnish-crest changed the title Add service data stream [Citrix ADC] Add Integration Package with Service Data Stream Oct 3, 2022
@kush-elastic
Copy link
Collaborator

/test

@kush-elastic kush-elastic added enhancement New feature or request Integration:Citrix-Netscaler Team:Service-Integrations Label for the Service Integrations team labels Oct 3, 2022
@harnish-crest harnish-crest mentioned this pull request Oct 3, 2022
Merged
4 tasks
@elasticmachine
Copy link

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@elasticmachine
Copy link

elasticmachine commented Oct 3, 2022 •
edited
Loading

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (2/2) 💚
Files 100.0% (2/2) 💚 2.538
Classes 100.0% (2/2) 💚 2.538
Methods 100.0% (19/19) 💚 9.305
Lines 97.783% (441/451) 👍 6.079
Conditionals 100.0% (0/0) 💚

@kush-elastic
Copy link
Collaborator

/test

@harnish-crest harnish-crest mentioned this pull request Oct 7, 2022
Merged
4 tasks
@kush-elastic
Copy link
Collaborator

/test

@muthu-mps muthu-mps self-requested a review October 10, 2022 09:42
yug-rajani
yug-rajani approved these changes Oct 11, 2022
View reviewed changes
packages/citrix_adc/_dev/build/docs/README.md Outdated
Metrics give you insight into the statistics of the Citrix ADC. Metrics data streams collected by the Citrix ADC integration include [service](https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/12.0/statistics/basic/service/), so that the user could monitor and troubleshoot the performance of the Citrix ADC instances.

This integration uses:
- `httpjson` filebeat module to collect `service` metrics.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please update as per this comment.

This was referenced Oct 13, 2022
Merged
Merged
muthu-mps
muthu-mps reviewed Nov 9, 2022
View reviewed changes
packages/citrix_adc/_dev/build/docs/README.md
Metrics give you insight into the statistics of the Citrix ADC. Metrics data streams collected by the Citrix ADC integration include [service](https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/12.0/statistics/basic/service/), so that the user could monitor and troubleshoot the performance of the Citrix ADC instances.

Note:
- Users can monitor and see the metrics inside the ingested documents for Citrix ADC in the logs-* index pattern from `Discover`.
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be metrics-* and not logs-* index pattern.

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 are using httpjson filebeat input. So user can see all the indices in logs-* format in Kibana Discover.

@harnish-crest harnish-crest marked this pull request as ready for review November 9, 2022 06:23
@harnish-crest harnish-crest requested a review from a team as a code owner November 9, 2022 06:23
@harnish-crest harnish-crest requested review from muthu-mps and removed request for lalit-satapathy November 9, 2022 06:25
@muthu-mps muthu-mps mentioned this pull request Nov 11, 2022
Closed
5 tasks
muthu-mps
muthu-mps approved these changes Nov 22, 2022
View reviewed changes
Copy link
Contributor

@muthu-mps muthu-mps 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 4c500fc into elastic:main Nov 22, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@yug-rajani yug-rajani yug-rajani approved these changes

@muthu-mps muthu-mps muthu-mps approved these changes

Assignees

@harnish-crest harnish-crest

Labels
enhancement New feature or request Team:Service-Integrations Label for the Service Integrations team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@harnish-crest @elasticmachine @kush-elastic @yug-rajani @muthu-mps