diff --git a/README.md b/README.md index ba96c0fb..5cd106b7 100644 --- a/README.md +++ b/README.md @@ -89,12 +89,14 @@ The Helm chart has its own [README](./chart/README.md). The application can be configured using the following environment variables, which are also loaded from `.env` file: -| Variable Name | Description | Default Value | -| -------------- | ----------------------------------------------------------- | ----------------------- | -| `LOGSTASH_URL` | URL to Logstash API | `http://localhost:9600` | -| `PORT` | Port on which the application will be exposed | `9198` | -| `HOST` | Host on which the application will be exposed | empty string | -| `LOG_LEVEL` | [Log level](https://pkg.go.dev/golang.org/x/exp/slog#Level) | empty (defaults to info) | +| Variable Name | Description | Default Value | +|---------------|-----------------------------------------------------------------------------------------------|-------------------------| +| `LOGSTASH_URL`| URL to Logstash API | `http://localhost:9600` | +| `PORT` | Port on which the application will be exposed | `9198` | +| `HOST` | Host on which the application will be exposed | `""` (empty string) | +| `LOG_LEVEL` | [Log level](https://pkg.go.dev/golang.org/x/exp/slog#Level) (defaults to "info" if not set) | `""` (empty string) | +| `HTTP_TIMEOUT`| Timeout for HTTP requests to Logstash API in [Go duration format](https://golang.org/pkg/time/#ParseDuration) | `2s` | + All configuration variables can be checked in the [config directory](./config/). @@ -105,7 +107,7 @@ All configuration variables can be checked in the [config directory](./config/). #### Available Commands - + - `make all`: Builds binary executables for all OS (Win, Darwin, Linux). - `make run`: Runs the Go Exporter application. - `make build-linux`: Builds a binary executable for Linux. @@ -127,7 +129,7 @@ All configuration variables can be checked in the [config directory](./config/). - `make helm-readme`: Generates Helm chart README.md file. - `make clean-elasticsearch`: Cleans Elasticsearch data, works only with default ES port. The command may take a very long time to complete. - `make help`: Shows info about available commands. - + #### File Structure @@ -138,91 +140,91 @@ The binary executables are saved in the out directory. #### Example Usage - + Builds binary executables for all OS (Win, Darwin, Linux): - + make all - + Runs the Go Exporter application: - + make run - + Builds a binary executable for Linux: - + make build-linux - + Builds a binary executable for Darwin: - + make build-darwin - + Builds a binary executable for Windows: - + make build-windows - + Builds a Docker image for the Go Exporter application: - + make build-docker - + Builds a multi-arch Docker image (`amd64` and `arm64`): - + make build-docker-multi - + Deletes all binary executables in the out directory: - + make clean - + Runs all tests: - + make test - + Displays test coverage report: - + make test-coverage - + Starts a Docker-compose configuration: - + make compose - + Starts a Docker-compose configuration until it's ready: - + make wait-for-compose - + Stops a Docker-compose configuration: - + make compose-down - + Verifies the metrics from the Go Exporter application: - + make verify-metrics - + Pulls the Docker image from the registry: - + make pull - + Shows logs from the Docker-compose configuration: - + make logs - + Minifies the binary executables: - + make minify - + Installs readme-generator-for-helm tool: - + make install-helm-readme - + Generates Helm chart README.md file: - + make helm-readme - + Cleans Elasticsearch data, works only with default ES port. The command may take a very long time to complete: - + make clean-elasticsearch - + Shows info about available commands: - + make help - + ## Helper Scripts