1// collectd - proto/collectd.proto
2// Copyright (C) 2015-2016 Sebastian Harl
3//
4// Permission is hereby granted, free of charge, to any person obtaining a
5// copy of this software and associated documentation files (the "Software"),
6// to deal in the Software without restriction, including without limitation
7// the rights to use, copy, modify, merge, publish, distribute, sublicense,
8// and/or sell copies of the Software, and to permit persons to whom the
9// Software is furnished to do so, subject to the following conditions:
10//
11// The above copyright notice and this permission notice shall be included in
12// all copies or substantial portions of the Software.
13//
14// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20// DEALINGS IN THE SOFTWARE.
21//
22// Authors:
23//   Sebastian Harl <sh at tokkee.org>
24
25syntax = "proto3";
26
27package collectd;
28option go_package = "collectd.org/rpc/proto";
29
30import "types.proto";
31
32service Collectd {
33  // PutValues reads the value lists from the PutValuesRequest stream.
34  // The gRPC server embedded into collectd will inject them into the system
35  // just like the network plugin.
36  rpc PutValues(stream PutValuesRequest) returns(PutValuesResponse);
37
38  // QueryValues returns a stream of matching value lists from collectd's
39  // internal cache.
40  rpc QueryValues(QueryValuesRequest) returns(stream QueryValuesResponse);
41}
42
43// The arguments to PutValues.
44message PutValuesRequest {
45  // value_list is the metric to be sent to the server.
46  collectd.types.ValueList value_list = 1;
47}
48
49// The response from PutValues.
50message PutValuesResponse {}
51
52// The arguments to QueryValues.
53message QueryValuesRequest {
54  // Query by the fields of the identifier. Only return values matching the
55  // specified shell wildcard patterns (see fnmatch(3)). Use '*' to match
56  // any value.
57  collectd.types.Identifier identifier = 1;
58}
59
60// The response from QueryValues.
61message QueryValuesResponse { collectd.types.ValueList value_list = 1; }
62