Skip to content

Commit

Permalink
Add Documentation To ES Configuration
Browse files Browse the repository at this point in the history
Signed-off-by: Mahad Zaryab <mahadzaryab1@gmail.com>
  • Loading branch information
mahadzaryab1 committed Oct 19, 2024
1 parent fe700fe commit 3ad639e
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions pkg/es/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ type Sniffing struct {
// Enabled, if set to true, enables sniffing for the ElasticSearch client.
Enabled bool `mapstructure:"enabled"`
// UseHTTPS, if set to true, sets the HTTP scheme to HTTPS when performing sniffing.
// For ESV8, the scheme is set to HTTPS by default, so this configuration is ignored.
UseHTTPS bool `mapstructure:"use_https"`
}

Expand Down Expand Up @@ -188,6 +189,8 @@ type BasicAuthentication struct {
// when making HTTP requests. Note that TokenFilePath and AllowTokenFromContext
// should not both be enabled. If both TokenFilePath and AllowTokenFromContext are set,
// the TokenFilePath will be ignored.
// For more information about token-based authentication in elasticsearch, check out
// https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html.
type BearerTokenAuthentication struct {
// FilePath contains the path to a file containing a bearer token.
FilePath string `mapstructure:"file_path"`
Expand Down

0 comments on commit 3ad639e

Please sign in to comment.