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

[panw_metrics] Add Palo Alto Networks metrics integration #11099

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

gpop63
Copy link
Contributor

@gpop63 gpop63 commented Sep 11, 2024

Overview

Data streams added:

  • interfaces
  • routing
  • system
  • vpn

Added unit, metric_type and dimension mappings.

Sample events files were created by me, they are not real events.

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.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

Screenshot from 2024-09-11 16-34-37
Screenshot from 2024-09-11 16-35-04
screencapture-localhost-5601-app-fleet-integrations-panw-metrics-0-0-1-add-integration-2024-09-11-16_44_41

@gpop63 gpop63 force-pushed the add_panw_metrics_integration branch 2 times, most recently from 2d260dd to b6cfbd5 Compare September 11, 2024 14:04
description: >
If the host is a container.

- name: os.build
Copy link
Contributor

Choose a reason for hiding this comment

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

Are these not ecs fields ?
If yes, we don't need to add these.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You suggest removing the entire agent.yml file from these data streams?

@ishleenk17 ishleenk17 changed the title [pawn_metrics] Add Palo Alto Networks metrics integration [panw_metrics] Add Palo Alto Networks metrics integration Sep 11, 2024

## Compatibility

The integration uses the [Pango](https://github.com/PaloAltoNetworks/pango) library to collect metrics from Palo Alto Networks firewalls.
Copy link
Contributor

Choose a reason for hiding this comment

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

@tommyers-elastic , should we consider mentioned, which version of PanOS, the integration is tested with, additionally?

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we also add a section for configuration, highlighting the details of connectivity parameters / connection string, how to get the API key, any specific permissions to be added?

Copy link
Contributor Author

@gpop63 gpop63 Sep 12, 2024

Choose a reason for hiding this comment

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

Do we have any documentation on permissions required, connection string etc? Not sure where to get this info.

Copy link
Contributor

Choose a reason for hiding this comment

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

If we do not have the information right now for this, let us leave a placeholder for Configuration (heading) , the content below it can be filled later.


### interfaces

The `interfaces` dataset collects detailed network interface statistics from Palo Alto Networks firewalls. It provides information about interface status, traffic throughput, packet counts, error rates, and configuration details for physical, logical, and high-availability (HA) interfaces.
Copy link
Contributor

Choose a reason for hiding this comment

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

As we might consider extending routing dataset in future, it may be best to modify as
including physical, logical, and high-availability (HA) interfaces

@agithomas
Copy link
Contributor

@tommyers-elastic , should we target for TSDB enablement in the initial version of the package? please advice.

- name: multi_hop_ttl
type: long
description: Time to Live (TTL) value for multi-hop BGP sessions.
- name: peer_address
Copy link
Contributor

Choose a reason for hiding this comment

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

@tommyers-elastic

Should we consider running an ingest pipeline to extract the values and keep the extracted field value as values of field of type ip and integer ?

But, if this field is a dimension field, we may need to keep this field , additionally

Copy link
Contributor

Choose a reason for hiding this comment

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

We can take it up in future too

type: keyword
dimension: true
description: IP address and port of the peer
- name: local_address
Copy link
Contributor

Choose a reason for hiding this comment

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

Similar to bgp.address, should we consider extracting the ip and port separately ?

Copy link
Contributor

Choose a reason for hiding this comment

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

We can take it up in future too

type: long
description: Total previous number of users connected to GlobalProtect
metric_type: gauge
- name: ipsec_tunnel
Copy link
Contributor

Choose a reason for hiding this comment

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

We have asked for the change for moving these metrics as part of the routing metricset. So, this may be an immediate future change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All ipsec_tunnel metrics should be moved to routing?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, we have recently requested for this change in beats.

@elasticmachine
Copy link

💚 Build Succeeded

History

Copy link

Quality Gate failed Quality Gate failed

Failed conditions
21.9% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants