Skip to content

Commit 27d5491

Browse files
authored
[v2] Add ES config comments (jaegertracing#6110)
Improve documentation Signed-off-by: Yuri Shkuro <[email protected]>
1 parent a22748e commit 27d5491

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

pkg/es/config/config.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,11 @@ const (
4040
// IndexOptions describes the index format and rollover frequency
4141
type IndexOptions struct {
4242
// Priority contains the priority of index template (ESv8 only).
43-
Priority int64 `mapstructure:"priority"`
43+
Priority int64 `mapstructure:"priority"`
44+
// DateLayout contains the format string used to format current time to part of the index name.
45+
// For example, "2006-01-02" layout will result in "jaeger-spans-yyyy-mm-dd".
46+
// If not specified, the default value is "2006-01-02".
47+
// See https://pkg.go.dev/time#Layout for more details on the syntax.
4448
DateLayout string `mapstructure:"date_layout"`
4549
// Shards is the number of shards per index in Elasticsearch.
4650
Shards int64 `mapstructure:"shards"`

0 commit comments

Comments
 (0)