Skip to content

documented how to access modular input metadata #429

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashah-splunk merged 1 commit into from
Jan 20, 2022
Merged

documented how to access modular input metadata #429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,22 @@ Don't
yield {'_time': time.time(), 'two': 2}
```

### Access metadata of modular inputs app
* In stream_events() method we can access modular input app metadata from InputDefinition object
* See [GitHub Commit](https://github.com/splunk/splunk-sdk-python/blob/develop/examples/github_commits/bin/github_commits.py) Modular input App example for reference.
```python
def stream_events(self, inputs, ew):
# other code

# access metadata (like server_host, server_uri, etc) of modular inputs app from InputDefinition object
# here inputs is a InputDefinition object
server_host = inputs.metadata["server_host"]
server_uri = inputs.metadata["server_uri"]

# Get the checkpoint directory out of the modular input's metadata
checkpoint_dir = inputs.metadata["checkpoint_dir"]
```

### Changelog

The [CHANGELOG](CHANGELOG.md) contains a description of changes for each version of the SDK. For the latest version, see the [CHANGELOG.md](https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md) on GitHub.
Expand Down
7 changes: 7 additions & 0 deletions examples/github_commits/bin/github_commits.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,13 @@ def stream_events(self, inputs, ew):
token = None
if "token" in input_item:
token = input_item["token"]

'''
access metadata (like server_host, server_uri, etc) of modular inputs app from InputDefinition object
here inputs is a InputDefinition object
server_host = inputs.metadata["server_host"]
server_uri = inputs.metadata["server_uri"]
'''
# Get the checkpoint directory out of the modular input's metadata
checkpoint_dir = inputs.metadata["checkpoint_dir"]

Expand Down