Splunk Search

Python splunk-sdk vs Python requests library

DavidGuarneri
Path Finder

Is there any particular reason for using Python splunk-sdk over standard restful API libraries or tools (such as Python requests library)? Using standard Python, you should be able to import data into pandas with 3 lines:

 

response = requests.get(url)
data = response.json()
pd.DataFrame(data)

 

What does splunk-sdk have that Python requests does not?

 

Thanks!

0 Karma
1 Solution

livehybrid
SplunkTrust
SplunkTrust

Is your intention to query Splunk using some external python code, or are you building a Splunk add-on and using the inbuilt Splunk python?

You may gain some benefits from using the sdk if connecting to Splunk API from outside Splunk using the SDK, such as pagination, error catching, validation etc. It can also help abstract away from the particular API endpoints needed for interacting with the REST API and be maintained to reflect changes in Splunk through version updates to the SDK libraries.

Let me know if you have a particular use-case and we can see if there is a particular benefit/drawback to using the SDK and/or requests library.

Please let me know how you get on and consider accepting this answer or adding karma this answer if it has helped.
Regards

Will

View solution in original post

livehybrid
SplunkTrust
SplunkTrust

Is your intention to query Splunk using some external python code, or are you building a Splunk add-on and using the inbuilt Splunk python?

You may gain some benefits from using the sdk if connecting to Splunk API from outside Splunk using the SDK, such as pagination, error catching, validation etc. It can also help abstract away from the particular API endpoints needed for interacting with the REST API and be maintained to reflect changes in Splunk through version updates to the SDK libraries.

Let me know if you have a particular use-case and we can see if there is a particular benefit/drawback to using the SDK and/or requests library.

Please let me know how you get on and consider accepting this answer or adding karma this answer if it has helped.
Regards

Will

Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

Laser Bananas and Edge Hubs: Exploring Operational Technology (OT) Data Through a ...

  OT is a different environment to traditional IT and can have interesting challenges when interfacing the ...

Event Series: Mastering AI Tokenomics and Splunk Agent Observability

Beyond the Black Box: Correlating AI Performance and Tokenomics with Splunk Agent Observability   As ...

span_metrics: The OpenTelemetry-Idiomatic Way to See Inside Your Services

You open a trace in Splunk Observability Cloud and everything looks fine. One root span, order-pipeline, with ...