Skip to content

Commit 1e7abcb

Browse files
committed
update example observability config
1 parent 6a25743 commit 1e7abcb

File tree

1 file changed

+32
-44
lines changed

1 file changed

+32
-44
lines changed

config/config-observability.yaml

Lines changed: 32 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -37,53 +37,41 @@ data:
3737
# this example block and unindented to be in the data block
3838
# to actually change the configuration.
3939
40-
# If non-empty, this enables queue proxy writing request logs to stdout.
41-
# The value determines the shape of the request logs and it must be a valid go text/template.
42-
# It is important to keep this as a single line. Multiple lines are parsed as separate entities
43-
# by most collection agents and will split the request logs into multiple records.
44-
#
45-
# The following fields and functions are available to the template:
46-
#
47-
# Request: An http.Request (see https://golang.org/pkg/net/http/#Request)
48-
# representing an HTTP request received by the server.
49-
#
50-
# Response:
51-
# struct {
52-
# Code int // HTTP status code (see https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml)
53-
# Size int // An int representing the size of the response.
54-
# Latency float64 // A float64 representing the latency of the response in seconds.
55-
# }
40+
# metrics-protocol field specifies the protocol used when exporting metrics
41+
# It supports either 'none' (the default), 'prometheus', 'http/protobuf' (OTLP HTTP), 'grpc' (OTLP gRPC)
42+
metrics-protocol: http/protobuf
43+
44+
# metrics-endpoint field specifies the destination metrics should be exporter to.
5645
#
57-
# Revision:
58-
# struct {
59-
# Name string // Knative revision name
60-
# Namespace string // Knative revision namespace
61-
# Service string // Knative service name
62-
# Configuration string // Knative configuration name
63-
# PodName string // Name of the pod hosting the revision
64-
# PodIP string // IP of the pod hosting the revision
65-
# }
46+
# The endpoint MUST be set when the protocol is http/protobuf or grpc.
47+
# The endpoint MUST NOT be set when the protocol is none.
6648
#
67-
logging.request-log-template: '{"httpRequest": {"requestMethod": "{{.Request.Method}}", "requestUrl": "{{js .Request.RequestURI}}", "requestSize": "{{.Request.ContentLength}}", "status": {{.Response.Code}}, "responseSize": "{{.Response.Size}}", "userAgent": "{{js .Request.UserAgent}}", "remoteIp": "{{js .Request.RemoteAddr}}", "serverIp": "{{.Revision.PodIP}}", "referer": "{{js .Request.Referer}}", "latency": "{{.Response.Latency}}s", "protocol": "{{.Request.Proto}}"}, "traceId": "{{index .Request.Header "X-B3-Traceid"}}"}'
49+
# When the protocol is prometheus the endpoint can accept a 'host:port' string to customize the
50+
# listening host interface and port.
51+
metrics-endpoint: http://promstack-kube-prometheus-prometheus.observability:9090/api/v1/otlp/v1/metrics
6852
69-
# metrics.backend-destination field specifies the system metrics destination.
70-
# It supports either prometheus (the default) or stackdriver.
71-
# Note: Using stackdriver will incur additional charges
72-
metrics.backend-destination: prometheus
53+
# metrics-export-interval specifies the global metrics reporting period for control and data plane components.
54+
# If a zero or negative value is passed the default reporting OTel period is used (60 secs).
55+
metrics-export-interval: 60s
7356
74-
# metrics.request-metrics-backend-destination specifies the request metrics
75-
# destination. If non-empty, it enables queue proxy to send request metrics.
76-
# Currently supported values: prometheus, stackdriver.
77-
metrics.request-metrics-backend-destination: prometheus
57+
# runtime-profiling indicates whether it is allowed to retrieve runtime profiling data from
58+
# the pods via an HTTP server in the format expected by the pprof visualization tool. When
59+
# enabled, the Knative Serving pods expose the profiling data on an alternate HTTP port 8008.
60+
# The HTTP context root for profiling is then /debug/pprof/.
61+
runtime-profiling: enabled
62+
63+
# tracing-protocol field specifies the protocol used when exporting metrics
64+
# It supports either 'none' (the default), 'prometheus', 'http/protobuf' (OTLP HTTP), 'grpc' (OTLP gRPC)
65+
# or `stdout` for debugging purposes
66+
tracing-protocol: http/protobuf
67+
68+
# tracing-endpoint field specifies the destination traces should be exporter to.
69+
#
70+
# The endpoint MUST be set when the protocol is http/protobuf or grpc.
71+
# The endpoint MUST NOT be set when the protocol is none.
72+
tracing-endpoint: http://jaeger-collector.observability:4318/v1/traces
7873
79-
# metrics.stackdriver-project-id field specifies the stackdriver project ID. This
80-
# field is optional. When running on GCE, application default credentials will be
81-
# used if this field is not provided.
82-
metrics.stackdriver-project-id: "<your stackdriver project id>"
74+
# tracing-sampling-rate allows the user to specify what percentage of all traces should be exported
75+
# The value should be between 0 (never sample) to 1 (always sample)
76+
tracing-sampling-rate: "1"
8377
84-
# metrics.allow-stackdriver-custom-metrics indicates whether it is allowed to send metrics to
85-
# Stackdriver using "global" resource type and custom metric type if the
86-
# metrics are not supported by "knative_revision" resource type. Setting this
87-
# flag to "true" could cause extra Stackdriver charge.
88-
# If metrics.backend-destination is not Stackdriver, this is ignored.
89-
metrics.allow-stackdriver-custom-metrics: "false"

0 commit comments

Comments
 (0)