Swap source.bytes and destination.bytes traffic log mappings
#32927
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This documentation currently mapps `Bytes Received` to `server.bytes` and `source.bytes` as well as `Bytes Sent` to `client.bytes` and `destination.bytes`. This mapping is incorrect as per the [Palot Alto Docs](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/traffic-log-fields), `bytes_sent` is defined as `Number of bytes in the client-to-server direction of the session.` and matches the ECS definitions for `client.bytes` and `source.bytes` being bytes from `client/source => server/destination`. Likewise, `bytes_received` is defined as `Number of bytes in the server-to-client direction of the session.` and matches the `destination.bytes` and `server.bytes` definitions in ECS being the bytes sent from `server/destination => client/source`. Furthermore, the [panw filebeat module mapping](https://github.com/elastic/beats/blob/v8.4.0/x-pack/filebeat/module/panw/panos/config/input.yml#L95) and [integration pipeline](https://github.com/elastic/integrations/blob/main/packages/panw/data_stream/panos/elasticsearch/ingest_pipeline/traffic.yml#L212) both follow the above conventions. This proposed change will map `Bytes Received` to `destination.bytes` and `Bytes Sent` to `client.bytes`.
botelastic
bot
added
the
needs_team
|
This pull request does not have a backport label.
To fixup this pull request, you need to add the backport labels for the needed
|
💚 Build Succeeded
Expand to view the summary
Build stats
❕ Flaky test reportNo test was executed to be analysed. 🤖 GitHub commentsTo re-run your PR in the CI, just comment with:
|
botelastic
bot
removed
the
needs_team
|
Pinging @elastic/obs-docs (Team:Docs) |
|
Pinging @elastic/security-external-integrations (Team:Security-External Integrations) |
efd6
reviewed
Aug 30, 2022
Swapping the values of `source.bytes` and `destination.bytes` in order to align the documentation with the changes implemented in #18525
efd6
approved these changes
Sep 7, 2022
dedemorton
added
backport-7.17
|
Going to merge this to get it into the published docs. Let me know if it's critical to backport this to other branches that are no longer in-service. (It will be backported to 8.4 and 7.17.) Thanks! |
mergify bot
pushed a commit
that referenced
this pull request
Sep 12, 2022
) * Swap `source.bytes` and `destination.bytes` traffic log mappings This documentation currently mapps `Bytes Received` to `server.bytes` and `source.bytes` as well as `Bytes Sent` to `client.bytes` and `destination.bytes`. This mapping is incorrect as per the [Palot Alto Docs](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/traffic-log-fields), `bytes_sent` is defined as `Number of bytes in the client-to-server direction of the session.` and matches the ECS definitions for `client.bytes` and `source.bytes` being bytes from `client/source => server/destination`. Likewise, `bytes_received` is defined as `Number of bytes in the server-to-client direction of the session.` and matches the `destination.bytes` and `server.bytes` definitions in ECS being the bytes sent from `server/destination => client/source`. Furthermore, the [panw filebeat module mapping](https://github.com/elastic/beats/blob/v8.4.0/x-pack/filebeat/module/panw/panos/config/input.yml#L95) and [integration pipeline](https://github.com/elastic/integrations/blob/main/packages/panw/data_stream/panos/elasticsearch/ingest_pipeline/traffic.yml#L212) both follow the above conventions. This proposed change will map `Bytes Received` to `destination.bytes` and `Bytes Sent` to `client.bytes`. * Swap `source.bytes` and `destination.bytes` traffic log mappings Swapping the values of `source.bytes` and `destination.bytes` in order to align the documentation with the changes implemented in #18525 * Run make update Co-authored-by: dedemorton <[email protected]> (cherry picked from commit 0930b9b)
mergify bot
pushed a commit
that referenced
this pull request
Sep 12, 2022
) * Swap `source.bytes` and `destination.bytes` traffic log mappings This documentation currently mapps `Bytes Received` to `server.bytes` and `source.bytes` as well as `Bytes Sent` to `client.bytes` and `destination.bytes`. This mapping is incorrect as per the [Palot Alto Docs](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/traffic-log-fields), `bytes_sent` is defined as `Number of bytes in the client-to-server direction of the session.` and matches the ECS definitions for `client.bytes` and `source.bytes` being bytes from `client/source => server/destination`. Likewise, `bytes_received` is defined as `Number of bytes in the server-to-client direction of the session.` and matches the `destination.bytes` and `server.bytes` definitions in ECS being the bytes sent from `server/destination => client/source`. Furthermore, the [panw filebeat module mapping](https://github.com/elastic/beats/blob/v8.4.0/x-pack/filebeat/module/panw/panos/config/input.yml#L95) and [integration pipeline](https://github.com/elastic/integrations/blob/main/packages/panw/data_stream/panos/elasticsearch/ingest_pipeline/traffic.yml#L212) both follow the above conventions. This proposed change will map `Bytes Received` to `destination.bytes` and `Bytes Sent` to `client.bytes`. * Swap `source.bytes` and `destination.bytes` traffic log mappings Swapping the values of `source.bytes` and `destination.bytes` in order to align the documentation with the changes implemented in #18525 * Run make update Co-authored-by: dedemorton <[email protected]> (cherry picked from commit 0930b9b)
dedemorton
pushed a commit
that referenced
this pull request
Sep 13, 2022
) (#33059) * Swap `source.bytes` and `destination.bytes` traffic log mappings This documentation currently mapps `Bytes Received` to `server.bytes` and `source.bytes` as well as `Bytes Sent` to `client.bytes` and `destination.bytes`. This mapping is incorrect as per the [Palot Alto Docs](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/traffic-log-fields), `bytes_sent` is defined as `Number of bytes in the client-to-server direction of the session.` and matches the ECS definitions for `client.bytes` and `source.bytes` being bytes from `client/source => server/destination`. Likewise, `bytes_received` is defined as `Number of bytes in the server-to-client direction of the session.` and matches the `destination.bytes` and `server.bytes` definitions in ECS being the bytes sent from `server/destination => client/source`. Furthermore, the [panw filebeat module mapping](https://github.com/elastic/beats/blob/v8.4.0/x-pack/filebeat/module/panw/panos/config/input.yml#L95) and [integration pipeline](https://github.com/elastic/integrations/blob/main/packages/panw/data_stream/panos/elasticsearch/ingest_pipeline/traffic.yml#L212) both follow the above conventions. This proposed change will map `Bytes Received` to `destination.bytes` and `Bytes Sent` to `client.bytes`. * Swap `source.bytes` and `destination.bytes` traffic log mappings Swapping the values of `source.bytes` and `destination.bytes` in order to align the documentation with the changes implemented in #18525 * Run make update Co-authored-by: dedemorton <[email protected]> (cherry picked from commit 0930b9b) Co-authored-by: Austin Smith <[email protected]>
dedemorton
pushed a commit
that referenced
this pull request
Sep 13, 2022
) (#33060) * Swap `source.bytes` and `destination.bytes` traffic log mappings This documentation currently mapps `Bytes Received` to `server.bytes` and `source.bytes` as well as `Bytes Sent` to `client.bytes` and `destination.bytes`. This mapping is incorrect as per the [Palot Alto Docs](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/traffic-log-fields), `bytes_sent` is defined as `Number of bytes in the client-to-server direction of the session.` and matches the ECS definitions for `client.bytes` and `source.bytes` being bytes from `client/source => server/destination`. Likewise, `bytes_received` is defined as `Number of bytes in the server-to-client direction of the session.` and matches the `destination.bytes` and `server.bytes` definitions in ECS being the bytes sent from `server/destination => client/source`. Furthermore, the [panw filebeat module mapping](https://github.com/elastic/beats/blob/v8.4.0/x-pack/filebeat/module/panw/panos/config/input.yml#L95) and [integration pipeline](https://github.com/elastic/integrations/blob/main/packages/panw/data_stream/panos/elasticsearch/ingest_pipeline/traffic.yml#L212) both follow the above conventions. This proposed change will map `Bytes Received` to `destination.bytes` and `Bytes Sent` to `client.bytes`. * Swap `source.bytes` and `destination.bytes` traffic log mappings Swapping the values of `source.bytes` and `destination.bytes` in order to align the documentation with the changes implemented in #18525 * Run make update Co-authored-by: dedemorton <[email protected]> (cherry picked from commit 0930b9b) Co-authored-by: Austin Smith <[email protected]>
chrisberkhout
pushed a commit
that referenced
this pull request
Jun 1, 2023
) * Swap `source.bytes` and `destination.bytes` traffic log mappings This documentation currently mapps `Bytes Received` to `server.bytes` and `source.bytes` as well as `Bytes Sent` to `client.bytes` and `destination.bytes`. This mapping is incorrect as per the [Palot Alto Docs](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/traffic-log-fields), `bytes_sent` is defined as `Number of bytes in the client-to-server direction of the session.` and matches the ECS definitions for `client.bytes` and `source.bytes` being bytes from `client/source => server/destination`. Likewise, `bytes_received` is defined as `Number of bytes in the server-to-client direction of the session.` and matches the `destination.bytes` and `server.bytes` definitions in ECS being the bytes sent from `server/destination => client/source`. Furthermore, the [panw filebeat module mapping](https://github.com/elastic/beats/blob/v8.4.0/x-pack/filebeat/module/panw/panos/config/input.yml#L95) and [integration pipeline](https://github.com/elastic/integrations/blob/main/packages/panw/data_stream/panos/elasticsearch/ingest_pipeline/traffic.yml#L212) both follow the above conventions. This proposed change will map `Bytes Received` to `destination.bytes` and `Bytes Sent` to `client.bytes`. * Swap `source.bytes` and `destination.bytes` traffic log mappings Swapping the values of `source.bytes` and `destination.bytes` in order to align the documentation with the changes implemented in #18525 * Run make update Co-authored-by: dedemorton <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This proposed change will map
Bytes Receivedtodestination.bytesandBytes Senttoclient.bytes.Why is it important?
This documentation currently mapps
Bytes Receivedtoserver.bytesandsource.bytesas well asBytes Senttoclient.bytesanddestination.bytes.This mapping is incorrect as per the Palot Alto Docs,
bytes_sentis defined asNumber of bytes in the client-to-server direction of the session.and matches the ECS definitions forclient.bytesandsource.bytesbeing bytes fromclient/source => server/destination.Likewise,
bytes_receivedis defined asNumber of bytes in the server-to-client direction of the session.and matches thedestination.bytesandserver.bytesdefinitions in ECS being the bytes sent fromserver/destination => client/source.Furthermore, the panw filebeat module mapping and integration pipeline both follow the above conventions.
Checklist
- [ ] My code follows the style guidelines of this project- [ ] I have commented my code, particularly in hard-to-understand areas- [ ] I have made corresponding change to the default configuration files- [ ] I have added tests that prove my fix is effective or that my feature worksCHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.EDIT: Below is a pull request which contains the fix made within the PANW filebeat module in order to swap these same two values. #18525.