Release/1.6.19

New features and APIs

• #441 JSONResultsReader added and deprecated ResultsReader
  • Pre-requisite: Query parameter 'output_mode' must be set to 'json'
  • Improves performance by approx ~80-90%
  • ResultsReader is deprecated and will be removed in future releases (NOTE: Please migrate to JSONResultsReader)
• #437 added setup_logging() method in splunklib for logging
• #426 Added new github_commit modular input example
• #392 Break out search argument to option parsing for v2 custom search commands
• #384 Added Float parameter validator for custom search commands
• #371 Modinput preserve 'app' context

Bug fixes

• #439 Modified POST method debug log to not log sensitive body/data
• #431 Add distsearch.conf to Stream Search Command examples [ issue#418 ]
• #419 Hec endpoint issue[ issue#345 ]
• #416 Removed strip() method in load_value() method from data.py file [ issue#400 ]
• #148 Identical entity names will cause an infinite loop

Minor changes

• #440 Github release workflow modified to generate docs
• #430 Fix indentation in README
• #429 documented how to access modular input metadata
• #427 Replace .splunkrc with .env file in test and examples
• #424 Float validator test fix
• #423 Python3 compatibility for ResponseReader.str()
• #422 ordereddict and all its reference removed
• #421 Update README.md
• #387 Update filter.py
• #331 Fix a couple of warnings spotted when running python 2.7 tests
• #330 client: use six.string_types instead of basestring
• #329 client: remove outdated comment in Index.submit
• #262 properly add parameters to request based on the method of the request
• #237 Don't output close tags if you haven't written a start tag
• #149 "handlers" stanza missing in examples/searchcommands_template/default/logging.conf

Release/1.6.18

Version 1.6.18

Bug fixes

• #405 Fix searchcommands_app example
• #406 Fix mod inputs examples
• #407 Fixed issue with Streaming and Generating Custom Search Commands dropping fields that aren't present in the first row of results. More details on how to opt-in to this fix can be found here:
  https://github.com/splunk/splunk-sdk-python/blob/develop/README.md#customization [ issue#401 ]

Minor changes

• #408 Add search mode example
• #409 Add Support for authorization tokens read from .splunkrc [ issue#388 ]
• #413 Default kvstore owner to nobody [ issue#231 ]

Release/1.6.17

Version 1.6.17

Bug fixes

• #383 Implemented the possibility to provide a SSLContext object to the connect method
• #396 Updated KVStore Methods to support dictionaries
• #397 Added code changes for encoding '/' in _key parameter in kvstore.data APIs.
• #398 Added dictionary support for KVStore "query" methods.
• #402 Fixed regression introduced in 1.6.15 to once again allow processing of empty input records in custom search commands (fix #376)
• #404 Fixed test case failure for 8.0 and latest(8.2.x) splunk version

Minor changes

• #381 Updated current year in conf.py
• #389 Fixed few typos
• #391 Fixed spelling error in client.py
• #393 Updated development status past 3
• #394 Updated Readme steps to run examples
• #395 Updated random_number.py
• #399 Moved CI tests to GitHub Actions
• #403 Removed usage of Easy_install to install SDK

Release/1.6.16

Version 1.6.16

Bug fixes

#312 Fix issue #309, avoid catastrophic backtracking in searchcommands

Release/1.6.15

Version 1.6.15

Bug fixes

#301 Fix chunk synchronization (Issue #150)
#327 Rename and cleanup follow-up for chunk synchronization
#352 Allow supplying of a key-value body when calling Context.post() (Issue #207)

Minor changes

#350 Initial end-to-end tests for streaming, reporting, generating custom search commands
#348 Update copyright years to 2020
#346 Readme updates to urls, terminology, and formatting
#317 Fix deprecation warnings

Release/1.6.14

Bug fix

• SearchCommand now correctly supports multibyte characters in Python 3.

Release/1.6.13

Version 1.6.13

Bug fix

• #307 Fixed regression in mod inputs which resulted in error ’file' object has no attribute 'readable’, by not forcing to text/bytes in mod inputs event writer any longer.

Minor changes

• Minor updates to the splunklib search commands to support Python3

Release/1.6.12

Version 1.6.12

New features and APIs

• Added Bearer token support using Splunk Token in v7.3
• Made modinput text consistent

Bug fixes

• Changed permissions from 755 to 644 for python files to pass appinspect checks
• Removed version check on ssl verify toggle

Known Issues

• Regression with modinputs tracked here: #307, we recommend using an earlier version of the SDK if modinputs are being used until the fix has been released

Release/1.6.11

Version 1.6.11

Bug Fix

• Fix custom search command V2 failures on Windows for Python3

Release/1.6.10

Version 1.6.10

Bug Fix

• Fix long type gets wrong values on windows for python 2