Skip to content

[stormshield] Fix pipeline descriptions and correct documentation claims#20030

Open
arenard wants to merge 1 commit into
elastic:mainfrom
arenard:stormshield-153-docs-fixes
Open

[stormshield] Fix pipeline descriptions and correct documentation claims#20030
arenard wants to merge 1 commit into
elastic:mainfrom
arenard:stormshield-153-docs-fixes

Conversation

@arenard

@arenard arenard commented Jul 8, 2026

Copy link
Copy Markdown

Proposed commit message

Fix the copy-pasted descriptions of the default and count ingest pipelines, remove field definitions that never appear in events (stormshield.tz, stormshield.duration, stormshield.msg, stormshield.origdst, stormshield.origdstport — the pipeline consumes tz into event.timezone, converts duration into event.duration, renames msg to message, and drops origdst/origdstport after converting them to destination.*), and correct the documentation:

  • the agent syslog processor is configured for RFC5424, so the README no longer presents the Legacy format as supported;
  • the compatibility section now covers SNS 4.x and 5.x, which share the same WELF key-value audit log format (SNS 5 has been generally available since February 2026).

Also documents how to collect SNS IPFIX flow records with the NetFlow integration, updates vendor documentation links to SNS v5, and uses arrows for menu paths per the documentation style guide.

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.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices (no dashboard changes)

Author's Checklist

  • The five removed field definitions are absent from all pipeline test expected documents and from sample_event.json (the definitions were dead documentation)
  • No pipeline behavior change: only description fields were touched in the pipelines

How to test this PR locally

cd packages/stormshield
elastic-package check
elastic-package test pipeline
elastic-package test static

All pass against stack 9.4.3.

Related issues

@arenard arenard requested a review from a team as a code owner July 8, 2026 09:50
@cla-checker-service

cla-checker-service Bot commented Jul 8, 2026

Copy link
Copy Markdown

💚 CLA has been signed

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@andrewkroh andrewkroh added needs CLA User must sign the Elastic Contributor License before review. documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:stormshield StormShield SNS labels Jul 8, 2026
@arenard arenard force-pushed the stormshield-153-docs-fixes branch 2 times, most recently from a7be5bf to 296568d Compare July 8, 2026 15:45
@andrewkroh andrewkroh removed the needs CLA User must sign the Elastic Contributor License before review. label Jul 8, 2026
@arenard arenard force-pushed the stormshield-153-docs-fixes branch 4 times, most recently from e6370d1 to 64ce75f Compare July 9, 2026 15:33
@arenard arenard changed the title stormshield: fix pipeline descriptions and correct documentation claims [stormshield] Fix pipeline descriptions and correct documentation claims Jul 9, 2026
@arenard arenard force-pushed the stormshield-153-docs-fixes branch from 64ce75f to 130df13 Compare July 10, 2026 11:24
@arenard arenard marked this pull request as ready for review July 10, 2026 11:24
Fix the copy-pasted descriptions of the default and count ingest pipelines,
remove field definitions that never appear in events (the pipeline consumes
tz into event.timezone, converts duration into event.duration, renames msg
to message, and drops origdst/origdstport after converting them to
destination fields), and correct the documentation: the agent syslog
processor is configured for RFC5424, so the README no longer presents the
Legacy format as supported, and the compatibility section now covers SNS 4.x
and 5.x, which share the same WELF key-value audit log format. Also
document how to collect SNS IPFIX flow records with the NetFlow integration,
update vendor links to the SNS v5 documentation, and use arrows for menu
paths per the documentation style guide.
@arenard arenard force-pushed the stormshield-153-docs-fixes branch from 130df13 to 18090cd Compare July 10, 2026 11:29
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

✅ All changelog entries have the correct PR link.

@infra-vault-gh-plugin-prod

Copy link
Copy Markdown

💚 Build Succeeded

History

@andrewkroh andrewkroh added the Team:Integration-Experience Security Integrations Integration Experience [elastic/integration-experience] label Jul 10, 2026
@infra-vault-gh-plugin-prod

Copy link
Copy Markdown

Pinging @elastic/integration-experience (Team:Integration-Experience)

@vera-review-bot

Copy link
Copy Markdown

No issues across the latest commits 18090cd.

A new commit triggers another review — at most once every 15 minutes. I skip the PR while it's approved or has merge conflicts.

🤖 AI-Generated Review | Vera Review Bot | 📚 Knowledge base: integration-skills

⚠️ Automated review — verify suggestions before applying.

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

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:stormshield StormShield SNS Team:Integration-Experience Security Integrations Integration Experience [elastic/integration-experience]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants