Skip to content

Simplify box_events onboarding#19604

Open
MichelLosier wants to merge 6 commits into
elastic:mainfrom
MichelLosier:simplify-box-events-agentless
Open

Simplify box_events onboarding#19604
MichelLosier wants to merge 6 commits into
elastic:mainfrom
MichelLosier:simplify-box-events-agentless

Conversation

@MichelLosier

@MichelLosier MichelLosier commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Description

Closes: https://github.com/elastic/ingest-dev/issues/8152

Updates box_events integration with a few changes to simplify the experience:

  • Sets agentless as the default deployment type
  • Groups authentication settings under a shared heading
  • Moves non-compulsory fields to show_user: false (Advanced section)
    • Including the httpjson settings which already have opinionated defaults
  • Adds tags to pipeline processors as required by adoption of the later package spec

Note although the original issue called for a "Connection Settings" section, this would be unused since the Connection related (url) field fall into the advanced section.

Proposed commit message

box events:

Sets agentless as the default deployment type and simplifies ordering and organization of variables.
Adds tags to pipeline processors as required by the new package-spec version

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

Screenshots

Screenshot 2026-06-17 at 3 46 15 PM

@github-actions

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.

@MichelLosier MichelLosier changed the title Simplify box events agentless Simplify box_events onboarding Jun 17, 2026
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@MichelLosier MichelLosier marked this pull request as ready for review June 17, 2026 22:49
@MichelLosier MichelLosier requested review from a team as code owners June 17, 2026 22:49
@MichelLosier MichelLosier self-assigned this Jun 17, 2026
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown

✅ All changelog entries have the correct PR link.

@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @MichelLosier

@andrewkroh andrewkroh added Integration:box_events Box Events Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] labels Jun 18, 2026
@infra-vault-gh-plugin-prod

Copy link
Copy Markdown

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@nimarezainia

Copy link
Copy Markdown
Contributor

@MichelLosier we want Agentless to be the default/recommended ingest method. Here the screenshot is still showing "Agent based" as the method of deployment.

This is the pattern:

We need a toggle for the datastream also:

image

@vera-review-bot

Copy link
Copy Markdown

👀 I have started reviewing the PR

- append:
field: error.message
value: '{{{ _ingest.on_failure_message }}}'
value: 'Processor {{{_ingest.on_failure_processor_type}}} with tag {{{_ingest.on_failure_processor_tag}}} in pipeline {{{_ingest.pipeline}}} failed with message: {{{_ingest.on_failure_message}}}'

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 MEDIUM data_stream/events/.../default.yml:1422

Top-level on_failure uses invalid _ingest.pipeline variable

The rewritten pipeline-level on_failure error message references {{{_ingest.pipeline}}}. Inside an on_failure block the only valid metadata fields are _ingest.on_failure_message, _ingest.on_failure_processor_type, _ingest.on_failure_processor_tag, and _ingest.on_failure_pipeline_ingest.pipeline does not exist in that context, so it renders as an empty string. The recorded error will read ...in pipeline failed with message:... with the pipeline name missing, degrading triage. Every processor-level on_failure handler in this same file already uses the correct {{{_ingest.on_failure_pipeline}}}, so this one occurrence is inconsistent with the rest of the pipeline.

Recommendation:

Use the on_failure-scoped pipeline variable, matching the processor-level handlers in this file:

on_failure:
  - set:
      field: event.kind
      value: pipeline_error
  - append:
      field: tags
      value: preserve_original_event
      allow_duplicates: false
  - append:
      field: error.message
      value: 'Processor {{{_ingest.on_failure_processor_type}}} with tag {{{_ingest.on_failure_processor_tag}}} in pipeline {{{_ingest.on_failure_pipeline}}} failed with message: {{{_ingest.on_failure_message}}}'

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

⚠️ Automated review — verify suggestions before applying.

- version: "3.3.2"
changes:
- description: Reorganize variables, and make agentless the default deployment mode.
type: bugfix

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 LOW changelog.yml:5

Changelog entry typed bugfix describes an enhancement

The new 3.3.2 entry is typed bugfix, but its description — "Reorganize variables, and make agentless the default deployment mode" — is a user-visible behavior/UX change (new default deployment mode plus Fleet UI re-layout via sections), not a defect fix. Mistyping it as bugfix misrepresents the change in the generated changelog and release notes.

Recommendation:

Type the entry as an enhancement:

- version: "3.3.2"
  changes:
    - description: Reorganize variables, and make agentless the default deployment mode.
      type: enhancement
      link: https://github.com/elastic/integrations/pull/19604

🤖 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

Integration:box_events Box Events Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants