Skip to content

Commit

Permalink
Add splunk configuration example. Explained properties.
Browse files Browse the repository at this point in the history
  • Loading branch information
aaukhatov authored and martinvisser committed Sep 25, 2023
1 parent 1215349 commit df7d4a9
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,34 @@ Arguments:

Upon installation, RET prompts you for the following config properties:

| Property | Description |
|-----------------|-----------------------------------------------------------------|
| splunk_base_url | The base url where your Splunk is deployed |
| splunk_app | The app name of your Splunk instance that should be searched on |
| Property | Description |
|-----------------|---------------------------------------------------------------------------------|
| splunk_base_url | The base url where your Splunk is deployed |
| splunk_app | The app name of your Splunk instance that should be searched on |
| indexes | Indexes of your Splunk instance that should be searched on (optional) |
| search_field | Unique identifier of your Splunk instance that should be searched on (optional) |

The final url that will be used by the Splunk plugin has this format:
```
"${splunkBaseUrl}/en-GB/app/${splunkApp}/search"
```

Configuration example
```
{
"plugin_version" : "0.1.0",
"base_url" : "https://my.splunk.com:8080",
"app" : "my_app",
"indexes" : "my_index_a, my_index_b",
"search_field" : "app_name",
"projects" : [ {
"name" : "my-project-x"
}, {
"name" : "my-project-y"
} ]
}
```

### Search on Splunk
You can search on Splunk and already type your query in the commandline, before opening the Splunk web page. Optionally,
RET allows you to specify some properties (Cloud Foundry application name and index).
Expand Down

0 comments on commit df7d4a9

Please sign in to comment.