2019-05-22 23:16:55 +02:00
package vmselect
import (
2021-07-07 16:04:23 +02:00
"embed"
2020-06-30 23:02:02 +02:00
"errors"
2019-05-22 23:16:55 +02:00
"flag"
2019-08-23 08:46:45 +02:00
"fmt"
2019-05-22 23:16:55 +02:00
"net/http"
2022-05-03 19:55:15 +02:00
"net/http/httputil"
"net/url"
2019-05-22 23:16:55 +02:00
"strings"
"time"
2020-09-10 23:28:19 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/app/vmselect/graphite"
2020-11-04 15:46:10 +01:00
"github.com/VictoriaMetrics/VictoriaMetrics/app/vmselect/netstorage"
2019-05-22 23:16:55 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/app/vmselect/prometheus"
"github.com/VictoriaMetrics/VictoriaMetrics/app/vmselect/promql"
2020-09-22 00:21:20 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/app/vmselect/searchutils"
2019-05-22 23:16:55 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/app/vmstorage"
2020-12-08 19:49:32 +01:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/cgroup"
2024-01-21 20:58:26 +01:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/flagutil"
2020-11-04 15:46:10 +01:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/fs"
2019-05-22 23:16:55 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/httpserver"
2023-06-20 07:31:57 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/httputils"
2019-05-22 23:16:55 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/logger"
2022-12-10 11:45:40 +01:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/promscrape"
2022-06-01 01:29:19 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/querytracer"
2019-05-28 16:17:19 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/lib/timerpool"
2019-05-22 23:16:55 +02:00
"github.com/VictoriaMetrics/metrics"
)
var (
2024-01-21 20:58:26 +01:00
deleteAuthKey = flagutil . NewPassword ( "deleteAuthKey" , "authKey for metrics' deletion via /api/v1/admin/tsdb/delete_series and /tags/delSeries" )
2020-01-17 14:43:47 +01:00
maxConcurrentRequests = flag . Int ( "search.maxConcurrentRequests" , getDefaultMaxConcurrentRequests ( ) , "The maximum number of concurrent search requests. " +
2022-10-09 12:56:55 +02:00
"It shouldn't be high, since a single request can saturate all the CPU cores, while many concurrently executed requests may require high amounts of memory. " +
"See also -search.maxQueueDuration and -search.maxMemoryPerQuery" )
2020-09-22 00:21:20 +02:00
maxQueueDuration = flag . Duration ( "search.maxQueueDuration" , 10 * time . Second , "The maximum time the request waits for execution when -search.maxConcurrentRequests " +
"limit is reached; see also -search.maxQueryDuration" )
2024-01-21 20:58:26 +01:00
resetCacheAuthKey = flagutil . NewPassword ( "search.resetCacheAuthKey" , "Optional authKey for resetting rollup cache via /internal/resetRollupResultCache call" )
2023-02-24 03:40:31 +01:00
logSlowQueryDuration = flag . Duration ( "search.logSlowQueryDuration" , 5 * time . Second , "Log queries with execution time exceeding this value. Zero disables slow query logging. " +
"See also -search.logQueryMemoryUsage" )
vmalertProxyURL = flag . String ( "vmalert.proxyURL" , "" , "Optional URL for proxying requests to vmalert. For example, if -vmalert.proxyURL=http://vmalert:8880 , then alerting API requests such as /api/v1/rules from Grafana will be proxied to http://vmalert:8880/api/v1/rules" )
2019-05-22 23:16:55 +02:00
)
2021-06-18 18:04:42 +02:00
var slowQueries = metrics . NewCounter ( ` vm_slow_queries_total ` )
2020-01-17 14:43:47 +01:00
func getDefaultMaxConcurrentRequests ( ) int {
2020-12-08 19:49:32 +01:00
n := cgroup . AvailableCPUs ( )
2020-01-17 14:43:47 +01:00
if n <= 4 {
n *= 2
}
if n > 16 {
// A single request can saturate all the CPU cores, so there is no sense
// in allowing higher number of concurrent requests - they will just contend
// for unavailable CPU time.
n = 16
}
return n
}
2019-05-22 23:16:55 +02:00
// Init initializes vmselect
func Init ( ) {
2020-11-04 15:46:10 +01:00
tmpDirPath := * vmstorage . DataPath + "/tmp"
fs . RemoveDirContents ( tmpDirPath )
netstorage . InitTmpBlocksDir ( tmpDirPath )
2019-05-22 23:16:55 +02:00
promql . InitRollupResultCache ( * vmstorage . DataPath + "/cache/rollupResult" )
2019-08-05 17:27:50 +02:00
2023-01-07 03:19:05 +01:00
concurrencyLimitCh = make ( chan struct { } , * maxConcurrentRequests )
2022-05-03 19:55:15 +02:00
initVMAlertProxy ( )
2019-05-22 23:16:55 +02:00
}
// Stop stops vmselect
func Stop ( ) {
promql . StopRollupResultCache ( )
}
2023-01-07 03:19:05 +01:00
var concurrencyLimitCh chan struct { }
2019-08-05 17:27:50 +02:00
var (
concurrencyLimitReached = metrics . NewCounter ( ` vm_concurrent_select_limit_reached_total ` )
concurrencyLimitTimeout = metrics . NewCounter ( ` vm_concurrent_select_limit_timeout_total ` )
_ = metrics . NewGauge ( ` vm_concurrent_select_capacity ` , func ( ) float64 {
2023-01-07 03:19:05 +01:00
return float64 ( cap ( concurrencyLimitCh ) )
2019-08-05 17:27:50 +02:00
} )
_ = metrics . NewGauge ( ` vm_concurrent_select_current ` , func ( ) float64 {
2023-01-07 03:19:05 +01:00
return float64 ( len ( concurrencyLimitCh ) )
2019-08-05 17:27:50 +02:00
} )
)
2021-07-09 16:04:28 +02:00
//go:embed vmui
var vmuiFiles embed . FS
2021-07-07 16:28:06 +02:00
2022-06-06 23:57:05 +02:00
var vmuiFileServer = http . FileServer ( http . FS ( vmuiFiles ) )
2021-07-07 16:28:06 +02:00
2021-07-07 11:59:03 +02:00
// RequestHandler handles remote read API requests
2019-05-22 23:16:55 +02:00
func RequestHandler ( w http . ResponseWriter , r * http . Request ) bool {
2023-12-01 16:24:59 +01:00
path := strings . Replace ( r . URL . Path , "//" , "/" , - 1 )
// Strip /prometheus and /graphite prefixes in order to provide path compatibility with cluster version
//
2024-04-18 02:54:20 +02:00
// See https://docs.victoriametrics.com/cluster-victoriametrics/#url-format
2023-12-01 16:24:59 +01:00
switch {
case strings . HasPrefix ( path , "/prometheus/" ) :
path = path [ len ( "/prometheus" ) : ]
case strings . HasPrefix ( path , "/graphite/" ) :
path = path [ len ( "/graphite" ) : ]
}
if handleStaticAndSimpleRequests ( w , r , path ) {
return true
}
// Handle non-trivial dynamic requests, which may take big amounts of time and resources.
2020-02-04 15:13:59 +01:00
startTime := time . Now ( )
2021-07-07 16:28:06 +02:00
defer requestDuration . UpdateDuration ( startTime )
2023-06-20 07:31:57 +02:00
tracerEnabled := httputils . GetBool ( r , "trace" )
2022-06-08 20:05:17 +02:00
qt := querytracer . New ( tracerEnabled , r . URL . Path )
2021-07-07 16:28:06 +02:00
2019-05-22 23:16:55 +02:00
// Limit the number of concurrent queries.
select {
2023-01-07 03:19:05 +01:00
case concurrencyLimitCh <- struct { } { } :
defer func ( ) { <- concurrencyLimitCh } ( )
2019-08-05 17:27:50 +02:00
default :
// Sleep for a while until giving up. This should resolve short bursts in requests.
concurrencyLimitReached . Inc ( )
2020-09-22 00:21:20 +02:00
d := searchutils . GetMaxQueryDuration ( r )
if d > * maxQueueDuration {
d = * maxQueueDuration
}
t := timerpool . Get ( d )
2019-08-05 17:27:50 +02:00
select {
2023-01-07 03:19:05 +01:00
case concurrencyLimitCh <- struct { } { } :
2019-08-05 17:27:50 +02:00
timerpool . Put ( t )
2023-01-07 03:19:05 +01:00
qt . Printf ( "wait in queue because -search.maxConcurrentRequests=%d concurrent requests are executed" , * maxConcurrentRequests )
defer func ( ) { <- concurrencyLimitCh } ( )
2023-05-03 10:42:17 +02:00
case <- r . Context ( ) . Done ( ) :
timerpool . Put ( t )
remoteAddr := httpserver . GetQuotedRemoteAddr ( r )
requestURI := httpserver . GetRequestURI ( r )
logger . Infof ( "client has cancelled the request after %.3f seconds: remoteAddr=%s, requestURI: %q" ,
2023-06-20 07:31:57 +02:00
time . Since ( startTime ) . Seconds ( ) , remoteAddr , requestURI )
2023-05-03 10:42:17 +02:00
return true
2019-08-05 17:27:50 +02:00
case <- t . C :
timerpool . Put ( t )
concurrencyLimitTimeout . Inc ( )
2019-08-23 08:46:45 +02:00
err := & httpserver . ErrorWithStatusCode {
2023-01-07 03:59:39 +01:00
Err : fmt . Errorf ( "couldn't start executing the request in %.3f seconds, since -search.maxConcurrentRequests=%d concurrent requests " +
2023-01-07 09:11:44 +01:00
"are executed. Possible solutions: to reduce query load; to add more compute resources to the server; " +
2023-01-11 10:06:05 +01:00
"to increase -search.maxQueueDuration=%s; to increase -search.maxQueryDuration; to increase -search.maxConcurrentRequests" ,
d . Seconds ( ) , * maxConcurrentRequests , maxQueueDuration ) ,
2024-01-24 17:55:06 +01:00
StatusCode : http . StatusTooManyRequests ,
2019-08-23 08:46:45 +02:00
}
2024-01-24 17:55:06 +01:00
w . Header ( ) . Add ( "Retry-After" , "10" )
2020-07-20 13:00:33 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2019-08-05 17:27:50 +02:00
return true
}
2019-05-22 23:16:55 +02:00
}
2021-06-18 18:04:42 +02:00
if * logSlowQueryDuration > 0 {
actualStartTime := time . Now ( )
defer func ( ) {
d := time . Since ( actualStartTime )
if d >= * logSlowQueryDuration {
remoteAddr := httpserver . GetQuotedRemoteAddr ( r )
2021-07-07 11:59:03 +02:00
requestURI := httpserver . GetRequestURI ( r )
2021-06-18 18:04:42 +02:00
logger . Warnf ( "slow query according to -search.logSlowQueryDuration=%s: remoteAddr=%s, duration=%.3f seconds; requestURI: %q" ,
* logSlowQueryDuration , remoteAddr , d . Seconds ( ) , requestURI )
slowQueries . Inc ( )
}
} ( )
}
2020-07-08 17:55:25 +02:00
if path == "/internal/resetRollupResultCache" {
2024-01-21 20:58:26 +01:00
if ! httpserver . CheckAuthFlag ( w , r , resetCacheAuthKey . Get ( ) , "resetCacheAuthKey" ) {
2020-07-08 17:55:25 +02:00
return true
}
promql . ResetRollupResultCache ( )
return true
2020-02-21 12:53:18 +01:00
}
2019-05-22 23:16:55 +02:00
if strings . HasPrefix ( path , "/api/v1/label/" ) {
2021-02-04 18:28:44 +01:00
s := path [ len ( "/api/v1/label/" ) : ]
2019-05-22 23:16:55 +02:00
if strings . HasSuffix ( s , "/values" ) {
labelValuesRequests . Inc ( )
labelName := s [ : len ( s ) - len ( "/values" ) ]
httpserver . EnableCORS ( w , r )
2022-06-01 01:29:19 +02:00
if err := prometheus . LabelValuesHandler ( qt , startTime , labelName , w , r ) ; err != nil {
2019-05-22 23:16:55 +02:00
labelValuesErrors . Inc ( )
sendPrometheusError ( w , r , err )
return true
}
return true
}
}
2020-11-16 13:49:46 +01:00
if strings . HasPrefix ( path , "/tags/" ) && ! isGraphiteTagsPath ( path ) {
2021-02-04 18:28:44 +01:00
tagName := path [ len ( "/tags/" ) : ]
2020-11-16 02:31:09 +01:00
graphiteTagValuesRequests . Inc ( )
if err := graphite . TagValuesHandler ( startTime , tagName , w , r ) ; err != nil {
graphiteTagValuesErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-11-16 02:31:09 +01:00
return true
}
return true
}
2022-07-06 10:47:26 +02:00
2019-05-22 23:16:55 +02:00
switch path {
case "/api/v1/query" :
queryRequests . Inc ( )
httpserver . EnableCORS ( w , r )
2022-06-01 01:29:19 +02:00
if err := prometheus . QueryHandler ( qt , startTime , w , r ) ; err != nil {
2019-05-22 23:16:55 +02:00
queryErrors . Inc ( )
sendPrometheusError ( w , r , err )
return true
}
return true
case "/api/v1/query_range" :
queryRangeRequests . Inc ( )
httpserver . EnableCORS ( w , r )
2022-06-01 01:29:19 +02:00
if err := prometheus . QueryRangeHandler ( qt , startTime , w , r ) ; err != nil {
2019-05-22 23:16:55 +02:00
queryRangeErrors . Inc ( )
sendPrometheusError ( w , r , err )
return true
}
return true
case "/api/v1/series" :
seriesRequests . Inc ( )
httpserver . EnableCORS ( w , r )
2022-06-01 01:29:19 +02:00
if err := prometheus . SeriesHandler ( qt , startTime , w , r ) ; err != nil {
2019-05-22 23:16:55 +02:00
seriesErrors . Inc ( )
sendPrometheusError ( w , r , err )
return true
}
return true
case "/api/v1/series/count" :
seriesCountRequests . Inc ( )
httpserver . EnableCORS ( w , r )
2020-02-04 15:13:59 +01:00
if err := prometheus . SeriesCountHandler ( startTime , w , r ) ; err != nil {
2019-05-22 23:16:55 +02:00
seriesCountErrors . Inc ( )
sendPrometheusError ( w , r , err )
return true
}
return true
case "/api/v1/labels" :
labelsRequests . Inc ( )
httpserver . EnableCORS ( w , r )
2022-06-01 01:29:19 +02:00
if err := prometheus . LabelsHandler ( qt , startTime , w , r ) ; err != nil {
2019-05-22 23:16:55 +02:00
labelsErrors . Inc ( )
sendPrometheusError ( w , r , err )
return true
}
return true
2020-04-22 18:57:36 +02:00
case "/api/v1/status/tsdb" :
2020-07-08 17:55:25 +02:00
statusTSDBRequests . Inc ( )
2022-06-08 17:43:05 +02:00
httpserver . EnableCORS ( w , r )
2022-06-09 18:46:26 +02:00
if err := prometheus . TSDBStatusHandler ( qt , startTime , w , r ) ; err != nil {
2020-07-08 17:55:25 +02:00
statusTSDBErrors . Inc ( )
2020-04-22 18:57:36 +02:00
sendPrometheusError ( w , r , err )
return true
}
return true
2019-05-22 23:16:55 +02:00
case "/api/v1/export" :
exportRequests . Inc ( )
2020-02-04 15:13:59 +01:00
if err := prometheus . ExportHandler ( startTime , w , r ) ; err != nil {
2019-05-22 23:16:55 +02:00
exportErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2019-05-22 23:16:55 +02:00
return true
}
return true
2020-10-12 19:01:51 +02:00
case "/api/v1/export/csv" :
exportCSVRequests . Inc ( )
if err := prometheus . ExportCSVHandler ( startTime , w , r ) ; err != nil {
exportCSVErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-10-12 19:01:51 +02:00
return true
}
return true
2020-09-26 03:29:45 +02:00
case "/api/v1/export/native" :
exportNativeRequests . Inc ( )
if err := prometheus . ExportNativeHandler ( startTime , w , r ) ; err != nil {
exportNativeErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-09-26 03:29:45 +02:00
return true
}
return true
2019-05-22 23:16:55 +02:00
case "/federate" :
federateRequests . Inc ( )
2020-02-04 15:13:59 +01:00
if err := prometheus . FederateHandler ( startTime , w , r ) ; err != nil {
2019-05-22 23:16:55 +02:00
federateErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2019-05-22 23:16:55 +02:00
return true
}
return true
2020-09-10 23:28:19 +02:00
case "/metrics/find" , "/metrics/find/" :
graphiteMetricsFindRequests . Inc ( )
httpserver . EnableCORS ( w , r )
if err := graphite . MetricsFindHandler ( startTime , w , r ) ; err != nil {
graphiteMetricsFindErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-09-10 23:28:19 +02:00
return true
}
return true
case "/metrics/expand" , "/metrics/expand/" :
graphiteMetricsExpandRequests . Inc ( )
httpserver . EnableCORS ( w , r )
if err := graphite . MetricsExpandHandler ( startTime , w , r ) ; err != nil {
graphiteMetricsExpandErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-09-10 23:28:19 +02:00
return true
}
return true
case "/metrics/index.json" , "/metrics/index.json/" :
graphiteMetricsIndexRequests . Inc ( )
httpserver . EnableCORS ( w , r )
if err := graphite . MetricsIndexHandler ( startTime , w , r ) ; err != nil {
graphiteMetricsIndexErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-09-10 23:28:19 +02:00
return true
}
return true
2020-11-23 11:33:17 +01:00
case "/tags/tagSeries" :
graphiteTagsTagSeriesRequests . Inc ( )
if err := graphite . TagsTagSeriesHandler ( startTime , w , r ) ; err != nil {
graphiteTagsTagSeriesErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-11-23 11:33:17 +01:00
return true
}
return true
case "/tags/tagMultiSeries" :
graphiteTagsTagMultiSeriesRequests . Inc ( )
if err := graphite . TagsTagMultiSeriesHandler ( startTime , w , r ) ; err != nil {
graphiteTagsTagMultiSeriesErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-11-23 11:33:17 +01:00
return true
}
return true
2020-11-16 00:25:38 +01:00
case "/tags" :
graphiteTagsRequests . Inc ( )
if err := graphite . TagsHandler ( startTime , w , r ) ; err != nil {
graphiteTagsErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-11-16 00:25:38 +01:00
return true
}
return true
2020-11-16 09:55:55 +01:00
case "/tags/findSeries" :
graphiteTagsFindSeriesRequests . Inc ( )
if err := graphite . TagsFindSeriesHandler ( startTime , w , r ) ; err != nil {
graphiteTagsFindSeriesErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-11-16 09:55:55 +01:00
return true
}
return true
2020-11-16 13:49:46 +01:00
case "/tags/autoComplete/tags" :
graphiteTagsAutoCompleteTagsRequests . Inc ( )
httpserver . EnableCORS ( w , r )
if err := graphite . TagsAutoCompleteTagsHandler ( startTime , w , r ) ; err != nil {
graphiteTagsAutoCompleteTagsErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-11-16 13:49:46 +01:00
return true
}
return true
2020-11-16 14:22:36 +01:00
case "/tags/autoComplete/values" :
graphiteTagsAutoCompleteValuesRequests . Inc ( )
httpserver . EnableCORS ( w , r )
if err := graphite . TagsAutoCompleteValuesHandler ( startTime , w , r ) ; err != nil {
graphiteTagsAutoCompleteValuesErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-11-16 14:22:36 +01:00
return true
}
return true
2020-11-23 14:26:20 +01:00
case "/tags/delSeries" :
2024-01-21 20:58:26 +01:00
if ! httpserver . CheckAuthFlag ( w , r , deleteAuthKey . Get ( ) , "deleteAuthKey" ) {
2020-11-23 14:35:59 +01:00
return true
}
2023-01-11 00:46:13 +01:00
graphiteTagsDelSeriesRequests . Inc ( )
2020-11-23 14:26:20 +01:00
if err := graphite . TagsDelSeriesHandler ( startTime , w , r ) ; err != nil {
graphiteTagsDelSeriesErrors . Inc ( )
2021-07-07 11:59:03 +02:00
httpserver . Errorf ( w , r , "%s" , err )
2020-11-23 14:26:20 +01:00
return true
}
return true
2023-04-01 08:25:04 +02:00
case "/render" :
graphiteRenderRequests . Inc ( )
if err := graphite . RenderHandler ( startTime , w , r ) ; err != nil {
graphiteRenderErrors . Inc ( )
httpserver . Errorf ( w , r , "error in %q: %s" , r . URL . Path , err )
return true
}
return true
2023-12-01 16:24:59 +01:00
case "/api/v1/admin/tsdb/delete_series" :
2024-01-21 20:58:26 +01:00
if ! httpserver . CheckAuthFlag ( w , r , deleteAuthKey . Get ( ) , "deleteAuthKey" ) {
2023-12-01 16:24:59 +01:00
return true
}
deleteRequests . Inc ( )
if err := prometheus . DeleteHandler ( startTime , r ) ; err != nil {
deleteErrors . Inc ( )
httpserver . Errorf ( w , r , "%s" , err )
return true
}
w . WriteHeader ( http . StatusNoContent )
return true
default :
return false
}
}
func handleStaticAndSimpleRequests ( w http . ResponseWriter , r * http . Request , path string ) bool {
// vmui access.
if path == "/vmui" || path == "/graph" {
// VMUI access via incomplete url without `/` in the end. Redirect to complete url.
// Use relative redirect, since the hostname and path prefix may be incorrect if VictoriaMetrics
// is hidden behind vmauth or similar proxy.
_ = r . ParseForm ( )
path = strings . TrimPrefix ( path , "/" )
newURL := path + "/?" + r . Form . Encode ( )
httpserver . Redirect ( w , newURL )
return true
}
if strings . HasPrefix ( path , "/graph/" ) {
// This is needed for serving /graph URLs from Prometheus datasource in Grafana.
path = strings . Replace ( path , "/graph/" , "/vmui/" , 1 )
}
if path == "/vmui/custom-dashboards" {
if err := handleVMUICustomDashboards ( w ) ; err != nil {
httpserver . Errorf ( w , r , "%s" , err )
return true
}
return true
}
2024-01-23 03:11:19 +01:00
if path == "/vmui/timezone" {
httpserver . EnableCORS ( w , r )
if err := handleVMUITimezone ( w ) ; err != nil {
httpserver . Errorf ( w , r , "%s" , err )
return true
}
return true
}
2023-12-01 16:24:59 +01:00
if strings . HasPrefix ( path , "/vmui/" ) {
if strings . HasPrefix ( path , "/vmui/static/" ) {
// Allow clients caching static contents for long period of time, since it shouldn't change over time.
// Path to static contents (such as js and css) must be changed whenever its contents is changed.
// See https://developer.chrome.com/docs/lighthouse/performance/uses-long-cache-ttl/
w . Header ( ) . Set ( "Cache-Control" , "max-age=31536000" )
}
r . URL . Path = path
vmuiFileServer . ServeHTTP ( w , r )
return true
}
if strings . HasPrefix ( path , "/functions" ) {
funcName := path [ len ( "/functions" ) : ]
funcName = strings . TrimPrefix ( funcName , "/" )
if funcName == "" {
graphiteFunctionsRequests . Inc ( )
if err := graphite . FunctionsHandler ( w , r ) ; err != nil {
graphiteFunctionsErrors . Inc ( )
httpserver . Errorf ( w , r , "%s" , err )
return true
}
return true
}
graphiteFunctionDetailsRequests . Inc ( )
if err := graphite . FunctionDetailsHandler ( funcName , w , r ) ; err != nil {
graphiteFunctionDetailsErrors . Inc ( )
httpserver . Errorf ( w , r , "%s" , err )
return true
}
return true
}
if path == "/vmalert" {
// vmalert access via incomplete url without `/` in the end. Redirect to complete url.
// Use relative redirect, since the hostname and path prefix may be incorrect if VictoriaMetrics
// is hidden behind vmauth or similar proxy.
httpserver . Redirect ( w , "vmalert/" )
return true
}
if strings . HasPrefix ( path , "/vmalert/" ) {
vmalertRequests . Inc ( )
if len ( * vmalertProxyURL ) == 0 {
w . WriteHeader ( http . StatusBadRequest )
w . Header ( ) . Set ( "Content-Type" , "application/json" )
fmt . Fprintf ( w , "%s" , ` { "status":"error","msg":"for accessing vmalert flag '-vmalert.proxyURL' must be configured"} ` )
return true
}
proxyVMAlertRequests ( w , r )
return true
}
switch path {
case "/api/v1/status/active_queries" :
statusActiveQueriesRequests . Inc ( )
httpserver . EnableCORS ( w , r )
promql . ActiveQueriesHandler ( w , r )
return true
case "/api/v1/status/top_queries" :
topQueriesRequests . Inc ( )
httpserver . EnableCORS ( w , r )
if err := prometheus . QueryStatsHandler ( w , r ) ; err != nil {
topQueriesErrors . Inc ( )
sendPrometheusError ( w , r , fmt . Errorf ( "cannot query status endpoint: %w" , err ) )
return true
}
return true
2022-12-10 11:45:40 +01:00
case "/metric-relabel-debug" :
promscrapeMetricRelabelDebugRequests . Inc ( )
promscrape . WriteMetricRelabelDebug ( w , r )
return true
2022-12-10 21:44:09 +01:00
case "/target-relabel-debug" :
promscrapeTargetRelabelDebugRequests . Inc ( )
promscrape . WriteTargetRelabelDebug ( w , r )
return true
2022-12-15 01:01:33 +01:00
case "/expand-with-exprs" :
expandWithExprsRequests . Inc ( )
prometheus . ExpandWithExprs ( w , r )
return true
2023-08-18 19:12:48 +02:00
case "/prettify-query" :
prettifyQueryRequests . Inc ( )
prometheus . PrettifyQuery ( w , r )
return true
2021-07-29 08:48:43 +02:00
case "/api/v1/rules" , "/rules" :
2019-12-03 18:32:57 +01:00
rulesRequests . Inc ( )
2022-07-06 10:47:26 +02:00
if len ( * vmalertProxyURL ) > 0 {
proxyVMAlertRequests ( w , r )
return true
}
// Return dumb placeholder for https://prometheus.io/docs/prometheus/latest/querying/api/#rules
w . Header ( ) . Set ( "Content-Type" , "application/json" )
fmt . Fprint ( w , ` { "status":"success","data": { "groups":[]}} ` )
2019-12-03 18:32:57 +01:00
return true
2021-08-02 16:28:09 +02:00
case "/api/v1/alerts" , "/alerts" :
2019-12-03 18:32:57 +01:00
alertsRequests . Inc ( )
2022-07-06 10:47:26 +02:00
if len ( * vmalertProxyURL ) > 0 {
proxyVMAlertRequests ( w , r )
return true
}
// Return dumb placeholder for https://prometheus.io/docs/prometheus/latest/querying/api/#alerts
w . Header ( ) . Set ( "Content-Type" , "application/json" )
fmt . Fprint ( w , ` { "status":"success","data": { "alerts":[]}} ` )
2019-12-03 18:32:57 +01:00
return true
2020-02-04 14:53:15 +01:00
case "/api/v1/metadata" :
2021-04-05 22:25:05 +02:00
// Return dumb placeholder for https://prometheus.io/docs/prometheus/latest/querying/api/#querying-metric-metadata
2020-02-04 14:53:15 +01:00
metadataRequests . Inc ( )
2021-11-09 17:03:50 +01:00
w . Header ( ) . Set ( "Content-Type" , "application/json" )
2020-02-04 14:53:15 +01:00
fmt . Fprintf ( w , "%s" , ` { "status":"success","data": { }} ` )
return true
2022-04-29 12:02:08 +02:00
case "/api/v1/status/buildinfo" :
buildInfoRequests . Inc ( )
w . Header ( ) . Set ( "Content-Type" , "application/json" )
2023-12-07 15:37:36 +01:00
// prometheus version is used here, which affects what API Grafana uses when retrieving label values.
// as new Grafana features are added that are customized for the Prometheus version, maybe the version will need to be increased.
// see this issue for more info: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5370
fmt . Fprintf ( w , "%s" , ` { "status":"success","data": { "version":"2.24.0"}} ` )
2022-04-29 12:02:08 +02:00
return true
2021-04-05 22:25:05 +02:00
case "/api/v1/query_exemplars" :
// Return dumb placeholder for https://prometheus.io/docs/prometheus/latest/querying/api/#querying-exemplars
queryExemplarsRequests . Inc ( )
2021-11-09 17:03:50 +01:00
w . Header ( ) . Set ( "Content-Type" , "application/json" )
2021-12-23 10:53:50 +01:00
fmt . Fprintf ( w , "%s" , ` { "status":"success","data":[]} ` )
2021-04-05 22:25:05 +02:00
return true
2019-05-22 23:16:55 +02:00
default :
return false
}
}
2020-11-16 13:49:46 +01:00
func isGraphiteTagsPath ( path string ) bool {
switch path {
// See https://graphite.readthedocs.io/en/stable/tags.html for a list of Graphite Tags API paths.
// Do not include `/tags/<tag_name>` here, since this will fool the caller.
case "/tags/tagSeries" , "/tags/tagMultiSeries" , "/tags/findSeries" ,
"/tags/autoComplete/tags" , "/tags/autoComplete/values" , "/tags/delSeries" :
return true
default :
return false
}
}
2019-05-22 23:16:55 +02:00
func sendPrometheusError ( w http . ResponseWriter , r * http . Request , err error ) {
2023-05-19 05:38:25 +02:00
logger . WarnfSkipframes ( 1 , "error in %q: %s" , httpserver . GetRequestURI ( r ) , err )
2019-05-22 23:16:55 +02:00
2021-11-09 17:03:50 +01:00
w . Header ( ) . Set ( "Content-Type" , "application/json" )
2019-08-23 08:46:45 +02:00
statusCode := http . StatusUnprocessableEntity
2020-06-30 23:02:02 +02:00
var esc * httpserver . ErrorWithStatusCode
if errors . As ( err , & esc ) {
2019-08-23 08:46:45 +02:00
statusCode = esc . StatusCode
}
2019-05-22 23:16:55 +02:00
w . WriteHeader ( statusCode )
2022-08-15 12:38:47 +02:00
2022-08-15 12:50:14 +02:00
var ure * promql . UserReadableError
2022-08-15 12:38:47 +02:00
if errors . As ( err , & ure ) {
2023-11-16 18:14:22 +01:00
err = ure
2022-08-15 12:38:47 +02:00
}
2019-05-22 23:16:55 +02:00
prometheus . WriteErrorResponse ( w , statusCode , err )
}
var (
2021-07-07 12:25:16 +02:00
requestDuration = metrics . NewHistogram ( ` vmselect_request_duration_seconds ` )
2019-05-22 23:16:55 +02:00
labelValuesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/label/ { }/values"} ` )
labelValuesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/label/ { }/values"} ` )
queryRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/query"} ` )
queryErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/query"} ` )
queryRangeRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/query_range"} ` )
queryRangeErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/query_range"} ` )
seriesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/series"} ` )
seriesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/series"} ` )
seriesCountRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/series/count"} ` )
seriesCountErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/series/count"} ` )
labelsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/labels"} ` )
labelsErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/labels"} ` )
2020-07-08 17:55:25 +02:00
statusTSDBRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/status/tsdb"} ` )
statusTSDBErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/status/tsdb"} ` )
statusActiveQueriesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/status/active_queries"} ` )
2020-04-22 18:57:36 +02:00
2020-12-27 11:53:50 +01:00
topQueriesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/status/top_queries"} ` )
topQueriesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/status/top_queries"} ` )
2019-05-22 23:16:55 +02:00
deleteRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/admin/tsdb/delete_series"} ` )
deleteErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/admin/tsdb/delete_series"} ` )
exportRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/export"} ` )
exportErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/export"} ` )
2020-10-12 19:01:51 +02:00
exportCSVRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/export/csv"} ` )
exportCSVErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/export/csv"} ` )
2020-09-26 03:29:45 +02:00
exportNativeRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/export/native"} ` )
exportNativeErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/api/v1/export/native"} ` )
2019-05-22 23:16:55 +02:00
federateRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/federate"} ` )
federateErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/federate"} ` )
2019-12-03 18:32:57 +01:00
2020-09-10 23:28:19 +02:00
graphiteMetricsFindRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/metrics/find"} ` )
graphiteMetricsFindErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/metrics/find"} ` )
graphiteMetricsExpandRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/metrics/expand"} ` )
graphiteMetricsExpandErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/metrics/expand"} ` )
graphiteMetricsIndexRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/metrics/index.json"} ` )
graphiteMetricsIndexErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/metrics/index.json"} ` )
2020-11-23 11:33:17 +01:00
graphiteTagsTagSeriesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/tags/tagSeries"} ` )
graphiteTagsTagSeriesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/tags/tagSeries"} ` )
graphiteTagsTagMultiSeriesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/tags/tagMultiSeries"} ` )
graphiteTagsTagMultiSeriesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/tags/tagMultiSeries"} ` )
2020-11-16 00:25:38 +01:00
graphiteTagsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/tags"} ` )
graphiteTagsErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/tags"} ` )
2020-11-16 02:31:09 +01:00
graphiteTagValuesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/tags/<tag_name>"} ` )
graphiteTagValuesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/tags/<tag_name>"} ` )
2020-11-16 09:55:55 +01:00
graphiteTagsFindSeriesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/tags/findSeries"} ` )
graphiteTagsFindSeriesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/tags/findSeries"} ` )
2020-11-16 13:49:46 +01:00
graphiteTagsAutoCompleteTagsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/tags/autoComplete/tags"} ` )
graphiteTagsAutoCompleteTagsErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/tags/autoComplete/tags"} ` )
2020-11-16 14:22:36 +01:00
graphiteTagsAutoCompleteValuesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/tags/autoComplete/values"} ` )
graphiteTagsAutoCompleteValuesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/tags/autoComplete/values"} ` )
2020-11-23 14:26:20 +01:00
graphiteTagsDelSeriesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/tags/delSeries"} ` )
graphiteTagsDelSeriesErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/tags/delSeries"} ` )
2023-04-01 08:25:04 +02:00
graphiteRenderRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/render"} ` )
graphiteRenderErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/render"} ` )
2022-12-10 11:45:40 +01:00
promscrapeMetricRelabelDebugRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/metric-relabel-debug"} ` )
2022-12-10 21:44:09 +01:00
promscrapeTargetRelabelDebugRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/target-relabel-debug"} ` )
2022-12-10 11:45:40 +01:00
2022-06-22 12:14:47 +02:00
graphiteFunctionsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/functions"} ` )
2023-04-01 08:25:04 +02:00
graphiteFunctionsErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/functions"} ` )
graphiteFunctionDetailsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/functions/<func_name>"} ` )
graphiteFunctionDetailsErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="/functions/<func_name>"} ` )
2021-09-16 10:18:26 +02:00
2022-12-15 01:01:33 +01:00
expandWithExprsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/expand-with-exprs"} ` )
2023-08-18 19:12:48 +02:00
prettifyQueryRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/prettify-query"} ` )
2022-12-15 01:01:33 +01:00
2022-07-06 10:47:26 +02:00
vmalertRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/vmalert"} ` )
rulesRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/rules"} ` )
alertsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/alerts"} ` )
2021-04-05 22:25:05 +02:00
metadataRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/metadata"} ` )
2022-04-29 10:36:28 +02:00
buildInfoRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/buildinfo"} ` )
2021-04-05 22:25:05 +02:00
queryExemplarsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/api/v1/query_exemplars"} ` )
2019-05-22 23:16:55 +02:00
)
2022-05-03 19:55:15 +02:00
2022-07-06 10:47:26 +02:00
func proxyVMAlertRequests ( w http . ResponseWriter , r * http . Request ) {
2022-05-03 19:55:15 +02:00
defer func ( ) {
err := recover ( )
if err == nil || err == http . ErrAbortHandler {
// Suppress http.ErrAbortHandler panic.
// See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1353
return
}
// Forward other panics to the caller.
panic ( err )
} ( )
2022-05-04 22:35:57 +02:00
r . Host = vmalertProxyHost
vmalertProxy . ServeHTTP ( w , r )
2022-05-03 19:55:15 +02:00
}
2022-05-04 22:35:57 +02:00
var (
vmalertProxyHost string
vmalertProxy * httputil . ReverseProxy
)
2022-05-03 19:55:15 +02:00
// initVMAlertProxy must be called after flag.Parse(), since it uses command-line flags.
func initVMAlertProxy ( ) {
if len ( * vmalertProxyURL ) == 0 {
return
}
proxyURL , err := url . Parse ( * vmalertProxyURL )
if err != nil {
2022-05-04 22:35:57 +02:00
logger . Fatalf ( "cannot parse -vmalert.proxyURL=%q: %s" , * vmalertProxyURL , err )
2022-05-03 19:55:15 +02:00
}
2022-05-04 22:35:57 +02:00
vmalertProxyHost = proxyURL . Host
vmalertProxy = httputil . NewSingleHostReverseProxy ( proxyURL )
2022-05-03 19:55:15 +02:00
}