Skip to content

Commit b16d716

Browse files
committed
Adding more documentation around Splunk logging
1 parent ffca03a commit b16d716

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,11 @@ You will need to:
7272

7373
(If you use GitHub Enterprise, you need the API & Login URL. This is usually `https://<GitHub Enterprise Host>/api/v3` and `https://<GitHub Enterprise Host>`.)
7474

75+
By default, all logging goes to STDOUT.
76+
If you use Splunk for logging, you need the Splunk HEC URL & access token. You can also set the source, sourcetype & index for all
77+
logged events.
78+
79+
7580
Next you need to decide if you'd like to deploy with lambda/API Gateway (follow Step 2a), or as a node server (follow Step 2b)
7681

7782
### 2a: Deployment with lambda and API Gateway
@@ -291,7 +296,7 @@ for more details.
291296

292297
### Can I use this shim to connect to GitHub directly from another OpenID client?
293298

294-
Yes. This implementation isn't complete, as it focusses exclusively on
299+
Yes. This implementation isn't complete, as it focusses exclusively on
295300
Cognito's requirements. However, it does follow the OpenID spec, and is
296301
complete enough to be able to use it as an OpenID connect provider. See the
297302
missing features section above for one or two caveats.

example-config.sh

+7
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ export COGNITO_REDIRECT_URI=# https://<Your Cognito Domain>/oauth2/idpresponse
99
# GITHUB_API_URL=# https://<GitHub Enterprise Host>/api/v3
1010
# GITHUB_LOGIN_URL=# https://<GitHub Enterprise Host>
1111

12+
# Variables required if Splunk logger is used
13+
# SPLUNK_URL=# https://<Splunk HEC>/services/collector/event/1.0
14+
# SPLUNK_TOKEN=# Splunk HTTP Event Collector token
15+
# SPLUNK_SOURCE=# Source for all logged events
16+
# SPLUNK_SOURCETYPE=# Sourcetype for all logged events
17+
# SPLUNK_INDEX=# Index for all logged events
18+
1219
# Variables required if deploying with API Gateway / Lambda
1320
export BUCKET_NAME=# An S3 bucket name to use as the deployment pipeline
1421
export STACK_NAME=# The name of the stack to create

0 commit comments

Comments
 (0)