Skip to content

Commit

Permalink
Add configuration description
Browse files Browse the repository at this point in the history
  • Loading branch information
Florianisme committed Nov 12, 2024
1 parent bdd23d9 commit 4c5f5d0
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It then formats these events and prints them to the console.
* I can not use my existing Log-Collection Stack (such as [ELK](https://www.elastic.co/de/elastic-stack)) on events


### Deploying the Application
## Deploying the Application
To deploy the application in your Kubernetes Cluster, run the following command:

```shell
Expand All @@ -19,7 +19,7 @@ A Pod in the newly created `event-logging` namespace will then start logging all


### Example Output
When scaling up a Deployment, this is what the output would look like:
This is what the output of another Pod's startup event would look like:

```json
{
Expand All @@ -36,3 +36,11 @@ When scaling up a Deployment, this is what the output would look like:
"reporter": "deployment-controller"
}
```

## Configuration
The application is configurable via the environment variables:

| Environment Variable | Description | Default Value |
|:--------------------:|------------------------------------------------------------------|:-------------:|
| TZ | Timezone of the logged event's timestamp (UTC for example) | |
| LOG_LEVEL | The application's internal logging level (not related to events) | INFO |

0 comments on commit 4c5f5d0

Please sign in to comment.