mirror of https://github.com/grafana/loki
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
319 lines
14 KiB
319 lines
14 KiB
// SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
package parse
|
|
|
|
import (
|
|
"reflect"
|
|
"slices"
|
|
|
|
"github.com/grafana/dskit/crypto/tls"
|
|
"github.com/grafana/dskit/grpcclient"
|
|
"github.com/grafana/dskit/kv/consul"
|
|
"github.com/grafana/dskit/kv/etcd"
|
|
"github.com/grafana/dskit/kv/memberlist"
|
|
"github.com/grafana/dskit/runtimeconfig"
|
|
"github.com/grafana/dskit/server"
|
|
|
|
"github.com/grafana/loki/v3/pkg/analytics"
|
|
"github.com/grafana/loki/v3/pkg/bloombuild"
|
|
"github.com/grafana/loki/v3/pkg/bloomgateway"
|
|
"github.com/grafana/loki/v3/pkg/compactor"
|
|
"github.com/grafana/loki/v3/pkg/distributor"
|
|
"github.com/grafana/loki/v3/pkg/indexgateway"
|
|
"github.com/grafana/loki/v3/pkg/ingester"
|
|
ingester_client "github.com/grafana/loki/v3/pkg/ingester/client"
|
|
"github.com/grafana/loki/v3/pkg/loghttp/push"
|
|
"github.com/grafana/loki/v3/pkg/loki"
|
|
"github.com/grafana/loki/v3/pkg/loki/common"
|
|
frontend "github.com/grafana/loki/v3/pkg/lokifrontend"
|
|
"github.com/grafana/loki/v3/pkg/querier"
|
|
"github.com/grafana/loki/v3/pkg/querier/queryrange"
|
|
querier_worker "github.com/grafana/loki/v3/pkg/querier/worker"
|
|
"github.com/grafana/loki/v3/pkg/ruler"
|
|
"github.com/grafana/loki/v3/pkg/runtime"
|
|
"github.com/grafana/loki/v3/pkg/scheduler"
|
|
"github.com/grafana/loki/v3/pkg/storage"
|
|
"github.com/grafana/loki/v3/pkg/storage/bucket"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/cache"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/client/alibaba"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/client/aws"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/client/azure"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/client/baidubce"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/client/gcp"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/client/ibmcloud"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/client/local"
|
|
"github.com/grafana/loki/v3/pkg/storage/chunk/client/openstack"
|
|
storage_config "github.com/grafana/loki/v3/pkg/storage/config"
|
|
"github.com/grafana/loki/v3/pkg/storage/stores/series/index"
|
|
"github.com/grafana/loki/v3/pkg/tracing"
|
|
"github.com/grafana/loki/v3/pkg/validation"
|
|
)
|
|
|
|
var (
|
|
// RootBlocks is an ordered list of root blocks with their associated descriptions.
|
|
// The order is the same order that will follow the markdown generation.
|
|
// Root blocks map to the configuration variables defined in Config of pkg/loki/loki.go
|
|
RootBlocks = []RootBlock{
|
|
{
|
|
Name: "server",
|
|
StructType: []reflect.Type{reflect.TypeOf(server.Config{})},
|
|
Desc: "Configures the server of the launched module(s).",
|
|
},
|
|
{
|
|
Name: "distributor",
|
|
StructType: []reflect.Type{reflect.TypeOf(distributor.Config{})},
|
|
Desc: "Configures the distributor.",
|
|
},
|
|
{
|
|
Name: "querier",
|
|
StructType: []reflect.Type{reflect.TypeOf(querier.Config{})},
|
|
Desc: "Configures the querier. Only appropriate when running all modules or just the querier.",
|
|
},
|
|
{
|
|
Name: "query_scheduler",
|
|
StructType: []reflect.Type{reflect.TypeOf(scheduler.Config{})},
|
|
Desc: "The query_scheduler block configures the Loki query scheduler. When configured it separates the tenant query queues from the query-frontend.",
|
|
},
|
|
{
|
|
Name: "frontend",
|
|
StructType: []reflect.Type{reflect.TypeOf(frontend.Config{})},
|
|
Desc: "The frontend block configures the Loki query-frontend.",
|
|
},
|
|
{
|
|
Name: "query_range",
|
|
StructType: []reflect.Type{reflect.TypeOf(queryrange.Config{})},
|
|
Desc: "The query_range block configures the query splitting and caching in the Loki query-frontend.",
|
|
},
|
|
{
|
|
Name: "ruler",
|
|
StructType: []reflect.Type{reflect.TypeOf(ruler.Config{})},
|
|
Desc: "The ruler block configures the Loki ruler.",
|
|
},
|
|
{
|
|
Name: "ingester_client",
|
|
StructType: []reflect.Type{reflect.TypeOf(ingester_client.Config{})},
|
|
Desc: "The ingester_client block configures how the distributor will connect to ingesters. Only appropriate when running all components, the distributor, or the querier.",
|
|
},
|
|
{
|
|
Name: "ingester",
|
|
StructType: []reflect.Type{reflect.TypeOf(ingester.Config{})},
|
|
Desc: "The ingester block configures the ingester and how the ingester will register itself to a key value store.",
|
|
},
|
|
{
|
|
Name: "index_gateway",
|
|
StructType: []reflect.Type{reflect.TypeOf(indexgateway.Config{})},
|
|
Desc: "The index_gateway block configures the Loki index gateway server, responsible for serving index queries without the need to constantly interact with the object store.",
|
|
},
|
|
{
|
|
Name: "storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(storage.Config{})},
|
|
Desc: "The storage_config block configures one of many possible stores for both the index and chunks. Which configuration to be picked should be defined in schema_config block.",
|
|
},
|
|
{
|
|
Name: "chunk_store_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(storage_config.ChunkStoreConfig{})},
|
|
Desc: "The chunk_store_config block configures how chunks will be cached and how long to wait before saving them to the backing store.",
|
|
},
|
|
{
|
|
Name: "schema_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(storage_config.SchemaConfig{})},
|
|
Desc: "Configures the chunk index schema and where it is stored.",
|
|
},
|
|
{
|
|
Name: "compactor",
|
|
StructType: []reflect.Type{reflect.TypeOf(compactor.Config{})},
|
|
Desc: "The compactor block configures the compactor component, which compacts index shards for performance.",
|
|
},
|
|
{
|
|
Name: "bloom_gateway",
|
|
StructType: []reflect.Type{reflect.TypeOf(bloomgateway.Config{})},
|
|
Desc: "Experimental: The bloom_gateway block configures the Loki bloom gateway server, responsible for serving queries for filtering chunks based on filter expressions.",
|
|
},
|
|
{
|
|
Name: "bloom_build",
|
|
StructType: []reflect.Type{reflect.TypeOf(bloombuild.Config{})},
|
|
Desc: "Experimental: The bloom_build block configures the Loki bloom planner and builder servers, responsible for building bloom filters.",
|
|
},
|
|
{
|
|
Name: "limits_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(validation.Limits{})},
|
|
Desc: "The limits_config block configures global and per-tenant limits in Loki. The values here can be overridden in the `overrides` section of the runtime_config file",
|
|
},
|
|
{
|
|
Name: "frontend_worker",
|
|
StructType: []reflect.Type{reflect.TypeOf(querier_worker.Config{})},
|
|
Desc: "The frontend_worker configures the worker - running within the Loki querier - picking up and executing queries enqueued by the query-frontend.",
|
|
},
|
|
{
|
|
Name: "table_manager",
|
|
StructType: []reflect.Type{reflect.TypeOf(index.TableManagerConfig{})},
|
|
Desc: "The table_manager block configures the table manager for retention.",
|
|
},
|
|
|
|
{
|
|
Name: "runtime_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(runtimeconfig.Config{})},
|
|
Desc: "Configuration for 'runtime config' module, responsible for reloading runtime configuration file.",
|
|
},
|
|
{
|
|
Name: "operational_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(runtime.Config{})},
|
|
Desc: "These are values which allow you to control aspects of Loki's operation, most commonly used for controlling types of higher verbosity logging, the values here can be overridden in the `configs` section of the `runtime_config` file.",
|
|
},
|
|
{
|
|
Name: "tracing",
|
|
StructType: []reflect.Type{reflect.TypeOf(tracing.Config{})},
|
|
Desc: "Configuration for tracing.",
|
|
},
|
|
{
|
|
Name: "analytics",
|
|
StructType: []reflect.Type{reflect.TypeOf(analytics.Config{})},
|
|
Desc: "Configuration for analytics.",
|
|
},
|
|
{
|
|
Name: "profiling",
|
|
StructType: []reflect.Type{reflect.TypeOf(loki.ProfilingConfig{})},
|
|
Desc: "Configuration for profiling options.",
|
|
},
|
|
|
|
{
|
|
Name: "common",
|
|
StructType: []reflect.Type{reflect.TypeOf(common.Config{})},
|
|
Desc: "Common configuration to be shared between multiple modules. If a more specific configuration is given in other sections, the related configuration within this section will be ignored.",
|
|
},
|
|
|
|
// Non-root blocks
|
|
// StoreConfig dskit type: https://github.com/grafana/dskit/blob/main/kv/client.go#L44-L52
|
|
{
|
|
Name: "consul",
|
|
StructType: []reflect.Type{reflect.TypeOf(consul.Config{})},
|
|
Desc: "Configuration for a Consul client. Only applies if the selected kvstore is consul.",
|
|
},
|
|
{
|
|
Name: "etcd",
|
|
StructType: []reflect.Type{reflect.TypeOf(etcd.Config{})},
|
|
Desc: "Configuration for an ETCD v3 client. Only applies if the selected kvstore is etcd.",
|
|
},
|
|
{
|
|
Name: "memberlist",
|
|
StructType: []reflect.Type{reflect.TypeOf(memberlist.KVConfig{})},
|
|
Desc: `Configuration for memberlist client. Only applies if the selected kvstore is memberlist.
|
|
|
|
When a memberlist config with atleast 1 join_members is defined, kvstore of type memberlist is automatically selected for all the components that require a ring unless otherwise specified in the component's configuration section.`,
|
|
},
|
|
// GRPC client
|
|
{
|
|
Name: "grpc_client",
|
|
StructType: []reflect.Type{reflect.TypeOf(grpcclient.Config{})},
|
|
Desc: "The grpc_client block configures the gRPC client used to communicate between a client and server component in Loki.",
|
|
},
|
|
// TLS config
|
|
{
|
|
Name: "tls_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(tls.ClientConfig{})},
|
|
Desc: "The TLS configuration.",
|
|
},
|
|
// Cache config
|
|
{
|
|
Name: "cache_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(cache.Config{})},
|
|
Desc: "The cache_config block configures the cache backend for a specific Loki component.",
|
|
},
|
|
// Schema periodic config
|
|
{
|
|
Name: "period_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(storage_config.PeriodConfig{})},
|
|
Desc: "The period_config block configures what index schemas should be used for from specific time periods.",
|
|
},
|
|
|
|
// Storage config
|
|
{
|
|
Name: "aws_storage_config",
|
|
// aws.StorageConfig is the underlying type for storage.NamedAWSStorageConfig
|
|
// having these as separate block entries would result in duplicate storage configs
|
|
// similar reasoning applies to other storage configs listed below
|
|
StructType: []reflect.Type{reflect.TypeOf(aws.StorageConfig{}), reflect.TypeOf(storage.NamedAWSStorageConfig{})},
|
|
Desc: "The aws_storage_config block configures the connection to dynamoDB and S3 object storage. Either one of them or both can be configured.",
|
|
},
|
|
{
|
|
Name: "azure_storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(azure.BlobStorageConfig{}), reflect.TypeOf(storage.NamedBlobStorageConfig{})},
|
|
Desc: "The azure_storage_config block configures the connection to Azure object storage backend.",
|
|
},
|
|
{
|
|
Name: "alibabacloud_storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(alibaba.OssConfig{}), reflect.TypeOf(storage.NamedOssConfig{})},
|
|
Desc: "The alibabacloud_storage_config block configures the connection to Alibaba Cloud Storage object storage backend.",
|
|
},
|
|
{
|
|
Name: "gcs_storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(gcp.GCSConfig{}), reflect.TypeOf(storage.NamedGCSConfig{})},
|
|
Desc: "The gcs_storage_config block configures the connection to Google Cloud Storage object storage backend.",
|
|
},
|
|
{
|
|
Name: "s3_storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(aws.S3Config{})},
|
|
Desc: "The s3_storage_config block configures the connection to Amazon S3 object storage backend.",
|
|
},
|
|
{
|
|
Name: "bos_storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(baidubce.BOSStorageConfig{}), reflect.TypeOf(storage.NamedBOSStorageConfig{})},
|
|
Desc: "The bos_storage_config block configures the connection to Baidu Object Storage (BOS) object storage backend.",
|
|
},
|
|
{
|
|
Name: "swift_storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(openstack.SwiftConfig{}), reflect.TypeOf(storage.NamedSwiftConfig{})},
|
|
Desc: "The swift_storage_config block configures the connection to OpenStack Object Storage (Swift) object storage backend.",
|
|
},
|
|
{
|
|
Name: "cos_storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(ibmcloud.COSConfig{}), reflect.TypeOf(storage.NamedCOSConfig{})},
|
|
Desc: "The cos_storage_config block configures the connection to IBM Cloud Object Storage (COS) backend.",
|
|
},
|
|
{
|
|
Name: "local_storage_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(local.FSConfig{}), reflect.TypeOf(storage.NamedFSConfig{})},
|
|
Desc: "The local_storage_config block configures the usage of local file system as object storage backend.",
|
|
},
|
|
{
|
|
Name: "named_stores_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(storage.NamedStores{})},
|
|
Desc: `Configures additional object stores for a given storage provider.
|
|
Supported stores: aws, azure, bos, filesystem, gcs, swift.
|
|
Example:
|
|
` + "```yaml" + `
|
|
storage_config:
|
|
named_stores:
|
|
aws:
|
|
store-1:
|
|
endpoint: s3://foo-bucket
|
|
region: us-west1
|
|
` + "```" + `
|
|
Named store from this example can be used by setting object_store to store-1 in period_config.`,
|
|
},
|
|
{
|
|
Name: "attributes_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(push.AttributesConfig{})},
|
|
Desc: "Define actions for matching OpenTelemetry (OTEL) attributes.",
|
|
},
|
|
{
|
|
Name: "thanos_object_store_config",
|
|
StructType: []reflect.Type{reflect.TypeOf(bucket.Config{})},
|
|
Desc: `The thanos_object_store_config block configures the connection to object storage backend using thanos-io/objstore clients. This will become the default way of configuring object store clients in future releases.
|
|
Currently this is opt-in and takes effect only when ` + "`-use-thanos-objstore` " + "is set to true.",
|
|
},
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
slices.SortFunc(RootBlocks, func(a, b RootBlock) int {
|
|
if a.Name < b.Name {
|
|
return -1
|
|
}
|
|
if a.Name > b.Name {
|
|
return 1
|
|
}
|
|
|
|
return 0
|
|
})
|
|
}
|
|
|