Skip to main content

CLI tool for querying Splunk logs. Search indexes, discover fields, and manage search jobs.

Project description

Splank

CLI tool for querying Splunk logs.

Setup

splank init

This creates ~/.config/splank/credentials.toml with your Splunk credentials.

Configuration

The credentials file supports multiple profiles:

default_profile = "prod"

[profiles.prod]
host = "splunk.example.com"
port = 8089
token = "your-token-here"
verify_ssl = true

[profiles.qa]
host = "splunk-qa.example.com"
port = 8089
username = "admin"
password = "changeme"
verify_ssl = true

Usage

# Search (uses default profile)
splank search 'index=main Level=ERROR' -m 10

# Search using specific profile
splank -p qa search 'index=main Level=ERROR'

# Discover indexes
splank discover 'web*'

# Discover with field info
splank discover 'app-*' --fields -o DISCOVERY.md

# Manage jobs
splank jobs
splank clear

Commands

  • init - Create credentials file
  • search - Execute SPL query
  • discover - Discover available indexes
  • jobs - List search jobs
  • clear - Clear my search jobs

Options

  • -p, --profile - Splunk profile to use (e.g., 'qa', 'prod')
  • -V, --version - Show version

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

splank-0.1.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

splank-0.1.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file splank-0.1.0.tar.gz.

File metadata

  • Download URL: splank-0.1.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for splank-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c71c9fac3e556d1c8983be810674ee2d284f7b6f0e668b87cb79e990effb580b
MD5 ff47099918f0482d7e2c0e52ca62fa6f
BLAKE2b-256 f6e951d5fe3686f0ba99281d7f84c05825e81eb5c889ccecefcf2608a589a592

See more details on using hashes here.

Provenance

The following attestation bundles were made for splank-0.1.0.tar.gz:

Publisher: publish.yml on vivainio/splank

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file splank-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: splank-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for splank-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16eca5b9613d35bd80144c8272f3cb27b9abe912ac702ee7d37c63fd5f4dc7ea
MD5 d1aff334d6268a05b24a10aae68edc25
BLAKE2b-256 9afa1715fe81f3034a7754302918c455624d6e36b59059c499498ba9c919776d

See more details on using hashes here.

Provenance

The following attestation bundles were made for splank-0.1.0-py3-none-any.whl:

Publisher: publish.yml on vivainio/splank

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page