API Reference

intake_splunk.core.SplunkSource(query, url, auth) Execute a query on Splunk
class intake_splunk.core.SplunkSource(query, url, auth, chunksize=5000, metadata=None)[source]

Execute a query on Splunk

Parameters:
query : str

String to pass to Splunk for execution. If it does not start with “|” or “search”, “search” will be prepended.

url : str

Endpoint on which to reach splunk, including protocol and port.

auth : (str, str) or str

Username/password to authenticate by.

chunksize : int
Attributes:
cache_dirs
datashape
description
hvplot

Returns a hvPlot object to provide a high-level plotting API.

plot

Returns a hvPlot object to provide a high-level plotting API.

plots

List custom associated quick-plots

Methods

close() Close open resources corresponding to this data source.
discover() Open resource and populate the source attributes.
read() Load entire dataset into a container and return it
read_chunked() Return iterator over container fragments of data source
read_partition(i) Return a (offset_tuple, container) corresponding to i-th partition.
to_dask() Return a dask container for this data source
to_spark() Provide an equivalent data object in Apache Spark
yaml([with_plugin]) Return YAML representation of this data-source
set_cache_dir  
to_dask()[source]

Return a dask container for this data source