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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Splunk HEC Event format #39774

Closed
wants to merge 2 commits into from
Closed

Fix Splunk HEC Event format #39774

wants to merge 2 commits into from

Conversation

Bre77
Copy link
Contributor

@Bre77 Bre77 commented Sep 8, 2020

Breaking change

The data format sent to Splunk has been corrected, you may need to update you searches in Splunk.

Proposed change

Correct the Splunk integrations JSON payload to conform to Splunk's HTTP Event Collector event endpoint. See https://docs.splunk.com/Documentation/SplunkCloud/latest/Data/FormateventsforHTTPEventCollector#Event_data

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

No changes from documentation, see https://www.home-assistant.io/integrations/splunk

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

@project-bot project-bot bot added this to Needs review in Dev Sep 8, 2020
@MartinHjelmare MartinHjelmare changed the title Fixed Splunk HEC Event format Fix Splunk HEC Event format Sep 8, 2020
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Unfortunately we can't accept changes to this integration until the interface code has been moved to a 3rd party library. Thanks for your contribution!

requests.post(
event_collector,
data=json.dumps(payload, cls=JSONEncoder),
data=json.dumps(body, cls=JSONEncoder),
Copy link
Member

Choose a reason for hiding this comment

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

Please extract the device specific interface code and data parsing to a standalone library published on PyPI.

https://developers.home-assistant.io/docs/creating_component_code_review#4-communication-with-devicesservices

Dev automation moved this from Needs review to Review in progress Sep 8, 2020
@MartinHjelmare
Copy link
Member

I'll close here now. If you want to do the refactor, please open a new PR. Thanks!

Dev automation moved this from Review in progress to Cancelled Sep 8, 2020
@Bre77 Bre77 mentioned this pull request Sep 16, 2020
21 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Dev
  
Cancelled
Development

Successfully merging this pull request may close these issues.

None yet

3 participants