Splunk Disclaimer for Log Streaming Instructions #22
Conversation
Added disclaimer for the Splunk installation.
|
Please advise. @timroster |
timroster
left a comment
timroster
left a comment
There was a problem hiding this comment.
Need more changes in general across this document with language changes as recommended by OM. Opening section should explicitly mention IBM Log Analysis and IBM Activity Tracker as services where this technique applies.
I think we can get away with existing screenshots as most seem close to my recollection which means a few places where logdnatopic are used is ok.
Can you move the pre-requisites for the workstation running Kafka Connect and Splunk in the docker container to the top of the document where it talks about the strategy of the implementation?
You can keep this PR open and just commit updates to the same branch, github will amend the PR with the updates.
| ### Run Kafka connect | ||
|
|
||
| Open a terminal. Run the below commands. The [base dir] is the directory under which we created the folder `kafka_splunk_integration`. | ||
| ### Run Kafka connectOpen a terminal. Run the below commands. The [base dir] is the directory under which we created the folder `kafka_splunk_integration`. |
There was a problem hiding this comment.
This has a markdown formatting error. The heading Run Kafka Connect is immediately followed by text instructions. There needs to be an empty line between a markdown heading and following text.
|
|
||
| The following instructions describe the steps necessary to create a Splunk instance that is deployed on a workstation using a Docker container. Additionally, configuring the Splunk system for communication with the IBM Event Streams through Kafka is demonstrated. | ||
|
|
||
| Check the following links to ensure that you have the latest installation pre-requisites satisfied for the platform being used. |
There was a problem hiding this comment.
I think it can be more clear overall when pre-requisites should be addressed at the top of the document, this helps the user to avoid surprises half-way through the activity. I noticed also at the top of the document (and throughout) that there is still language like LogDNA.
|
|
||
| ### Install Splunk | ||
|
|
||
| Typically, those interested in this functionality already have Splunk implemented in their environment and have the technical expertise to configure it with the Kafka messaging services. |
There was a problem hiding this comment.
I'd delete this entire statement, even if the first statement is true, I think that the second one is really the point of this guide. Users that already know how to publish events in a Kafka topic to Splunk would have stopped after they had set up log streaming from IBM Log Analysis or Activity Tracker to Event Streams.
2 participants
name: Pull request
about: Help us improve our package
title: "[WIP|Feature|Fix]"
labels: do-not-merge
Community Note
Pull requests are always welcome, we are always thrilled to receive them and we do our best to process them quickly. If your pull request is not accepted on the first try, don't get discouraged!
[WIP]prefix to the pull request title and add thedo-not-mergelabel.[WIP],[Feature]or[Fix]. If the category is unknown use[WIP], once the PR is ready to be merged replace[WIP]for the right category.git commit -sWhat this PR does / Why we need it?
References
List of issues this PR fixes using the prefix
Fixes,ClosesorResolvesand the issue number or link. Format Examples:Fixes #<issue number>,Closes <link of issue>orResolves #<issue number>.The issues will be closed automatically when this pull request is merged. Example:
How I did it?
Description of the changes done.
How to verify it?
Instructions to test the change. Include screenshot or test output as evidence or as example of expected results for the tests.
Description for the changelog
Write a short (one line) summary that describes the changes in this pull request for inclusion in the changelog