aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/engine/search_protocol_metrics.h
blob: 17b68b678b38baf7e4d65909d92af2bf4b223346 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include <vespa/metrics/valuemetric.h>
#include <vespa/metrics/countmetric.h>
#include <vespa/metrics/metricset.h>
#include <mutex>

namespace search::engine {

/**
 * Metrics for the proto rpc adapter component implementing the search
 * protocol in proton.
 **/
class SearchProtocolMetrics : public metrics::MetricSet
{
public:
    // sub-metrics for query request/reply
    struct QueryMetrics : metrics::MetricSet {
        metrics::DoubleAverageMetric latency;
        metrics::LongAverageMetric   request_size;
        metrics::LongAverageMetric   reply_size;

        QueryMetrics(metrics::MetricSet *parent);
        ~QueryMetrics() override;
    };

    // value-wrapper used when collecting and reporting query metrics
    struct QueryStats {
        double latency;
        size_t request_size;
        size_t reply_size;
        QueryStats() : latency(0.0), request_size(0), reply_size(0) {}
    };

    // sub-metrics for docsum request/reply
    struct DocsumMetrics : metrics::MetricSet {
        metrics::DoubleAverageMetric latency;
        metrics::LongAverageMetric   request_size;
        metrics::LongAverageMetric   reply_size;
        metrics::LongCountMetric     requested_documents;

        DocsumMetrics(metrics::MetricSet *parent);
        ~DocsumMetrics() override;
    };

    // value-wrapper used when collecting and reporting docsum metrics
    struct DocsumStats {
        double latency;
        size_t request_size;
        size_t reply_size;
        size_t requested_documents;
        DocsumStats() : latency(0.0), request_size(0), reply_size(0), requested_documents(0) {}
    };

private:
    std::mutex    _lock;
    QueryMetrics  _query;
    DocsumMetrics _docsum;

public:
    SearchProtocolMetrics();
    ~SearchProtocolMetrics() override;

    const QueryMetrics &query() const { return _query; }
    const DocsumMetrics &docsum() const { return _docsum; }

    void update_query_metrics(const QueryStats &stats);
    void update_docsum_metrics(const DocsumStats &stats);
};

}