[Citrix ADC] Add Integration Package with VPN Data Stream #4473

harnish-crest · 2022-10-19T10:32:18Z

Enhancement

What does this PR do?

Added 1 data stream (vpn 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

kush-elastic · 2022-10-19T10:34:28Z

/test

elasticmachine · 2022-10-19T10:35:39Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-12-19T13:04:56.727+0000
Duration: 17 min 46 sec

Test stats 🧪

Test	Results
Failed	0
Passed	31
Skipped	0
Total	31

🤖 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 · 2022-10-19T10:49:49Z

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

elasticmachine · 2022-10-19T10:50:05Z

🌐 Coverage report

Name	Metrics % (`covered/total`)	Diff
Packages	100.0% (`5/5`)	💚
Files	100.0% (`5/5`)	💚 6.667
Classes	100.0% (`5/5`)	💚 6.667
Methods	100.0% (`48/48`)	💚 15.0
Lines	97.782% (`1102/1127`)	👍 1.76
Conditionals	100.0% (`0/0`)	💚

kush-elastic

Add the dashboard screenshot in view mode rather than adding it in edit mode.

kush-elastic

LGTM!

kush-elastic · 2022-11-08T13:00:13Z

/test

botelastic · 2022-12-08T14:01:57Z

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 · 2022-12-08T15:01:57Z

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!

muthu-mps · 2022-12-14T11:56:11Z

packages/citrix_adc/data_stream/vpn/fields/fields.yml

+                    - name: count
+                      type: float
+                      description: Number of SSL VPN tunnels formed between VPN server and client.
+                      metric_type: counter


This cannot be a counter metric_type.

muthu-mps · 2022-12-14T11:56:14Z

packages/citrix_adc/data_stream/vpn/fields/fields.yml

+            - name: count
+              type: float
+              description: Number of client configuration requests received by VPN server.
+              metric_type: counter


Same here we could not get a cumulative incremental value. Please change to gauge.

@muthu-mps seems like these fields should be counter. Also here is the official document which shows both fields metric_type is counter.

client_server.request.hit.count: https://support.citrix.com/article/CTX133884/citrix-adc-sslvpn-counters#:~:text=Number%20of%20client%20configuration%20requests%20received%20by%20VPN%20server

configuration_request_served.count: https://support.citrix.com/article/CTX133884/citrix-adc-sslvpn-counters#:~:text=Number%20of%20client%20configuration%20requests%20received%20by%20VPN%20server

The counters which you refer here is something which captures all the response fields and its different from what we consider as metric_type. The metric_type gauge is a single-valued metric which goes up and down. Ex: temperature. The metric_type: counter is a cumulative type which only goes up. Ex: Number of requests processed by web server.
I would recommend you to revisit the metric_type for all the fields and make changes wherever applicable.

For the client_server.request.hit.count it could be gauge. So we can update it as per your suggestions. But for the configuration_request_served.count, it seems like a counter as per your example. Also as per our understanding, it aligns more with the counter. But let me know if you still want to change it to counter, we'll change it for this field too.

I would recommend to keep both as gauge values.

muthu-mps · 2022-12-15T05:56:00Z

@SubhrataK - Please take a look into the changes.

muthu-mps

Looks Good!

elasticmachine · 2022-12-20T10:13:35Z

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

harnish-crest added 2 commits October 19, 2022 16:00

Add VPN data stream

7fc0df1

update changelog.yml

0452caa

kush-elastic requested review from lalit-satapathy, muthu-mps and kush-elastic October 19, 2022 10:35

kush-elastic assigned harnish-crest Oct 19, 2022

kush-elastic added enhancement New feature or request Integration:Citrix-Netscaler Team:Service-Integrations Label for the Service Integrations team labels Oct 19, 2022

harnish-crest marked this pull request as draft October 19, 2022 10:40

update visualization titles

8cfc830

kush-elastic requested changes Nov 8, 2022

View reviewed changes

minor change in dashboard screenshot

dcfc9a7

kush-elastic approved these changes Nov 8, 2022

View reviewed changes

muthu-mps mentioned this pull request Nov 11, 2022

Create package to monitor server workers using Citrix ADC (Netscaler) #3746

Closed

5 tasks

botelastic bot added the Stalled label Dec 8, 2022

resolve merge conflicts

9f77683

botelastic bot removed the Stalled label Dec 13, 2022

harnish-crest marked this pull request as ready for review December 13, 2022 10:31

harnish-crest requested a review from a team as a code owner December 13, 2022 10:31

muthu-mps reviewed Dec 14, 2022

View reviewed changes

muthu-mps requested a review from SubhrataK December 14, 2022 12:09

harnish-crest added 2 commits December 15, 2022 14:42

resolve merge conflicts

e310c83

minor changes in config file

a364043

harnish-crest requested review from muthu-mps and removed request for lalit-satapathy and SubhrataK December 15, 2022 09:28

kush-elastic requested a review from SubhrataK December 15, 2022 09:28

SubhrataK approved these changes Dec 19, 2022

View reviewed changes

update README.md

e1abc82

muthu-mps approved these changes Dec 20, 2022

View reviewed changes

kush-elastic merged commit 18166df into elastic:main Dec 20, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Citrix ADC] Add Integration Package with VPN Data Stream #4473

[Citrix ADC] Add Integration Package with VPN Data Stream #4473

harnish-crest commented Oct 19, 2022 •

edited

Loading

kush-elastic commented Oct 19, 2022

elasticmachine commented Oct 19, 2022 •

edited

Loading

Build stats

Test stats 🧪

elasticmachine commented Oct 19, 2022

elasticmachine commented Oct 19, 2022 •

edited

Loading

kush-elastic left a comment

kush-elastic left a comment

kush-elastic commented Nov 8, 2022

botelastic bot commented Dec 8, 2022

botelastic bot commented Dec 8, 2022

muthu-mps Dec 14, 2022

muthu-mps Dec 14, 2022

harnish-crest Dec 14, 2022

muthu-mps Dec 14, 2022

harnish-crest Dec 15, 2022

muthu-mps Dec 15, 2022

muthu-mps commented Dec 15, 2022

muthu-mps left a comment

elasticmachine commented Dec 20, 2022

[Citrix ADC] Add Integration Package with VPN Data Stream #4473

[Citrix ADC] Add Integration Package with VPN Data Stream #4473

Conversation

harnish-crest commented Oct 19, 2022 • edited Loading

What does this PR do?

Checklist

How to test this PR locally

Related issues

Screenshots

kush-elastic commented Oct 19, 2022

elasticmachine commented Oct 19, 2022 • edited Loading

💚 Build Succeeded

Build stats

Test stats 🧪

🤖 GitHub comments

elasticmachine commented Oct 19, 2022

🚀 Benchmarks report

elasticmachine commented Oct 19, 2022 • edited Loading

🌐 Coverage report

kush-elastic left a comment

Choose a reason for hiding this comment

kush-elastic left a comment

Choose a reason for hiding this comment

kush-elastic commented Nov 8, 2022

botelastic bot commented Dec 8, 2022

botelastic bot commented Dec 8, 2022

muthu-mps Dec 14, 2022

Choose a reason for hiding this comment

muthu-mps Dec 14, 2022

Choose a reason for hiding this comment

harnish-crest Dec 14, 2022

Choose a reason for hiding this comment

muthu-mps Dec 14, 2022

Choose a reason for hiding this comment

harnish-crest Dec 15, 2022

Choose a reason for hiding this comment

muthu-mps Dec 15, 2022

Choose a reason for hiding this comment

muthu-mps commented Dec 15, 2022

muthu-mps left a comment

Choose a reason for hiding this comment

elasticmachine commented Dec 20, 2022

harnish-crest commented Oct 19, 2022 •

edited

Loading

elasticmachine commented Oct 19, 2022 •

edited

Loading

elasticmachine commented Oct 19, 2022 •

edited

Loading