grpc plugin: Implement the ListValues() RPC.
[collectd.git] / proto / collectd.proto
1 // collectd - proto/collectd.proto
2 // Copyright (C) 2015 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
25 syntax = "proto3";
26
27 package collectd;
28
29 import "types.proto";
30 import "google/protobuf/timestamp.proto";
31
32 service Collectd {
33         // Dispatch collected values to collectd.
34         rpc DispatchValues(DispatchValuesRequest) returns (DispatchValuesReply);
35
36         // Retrieve a list of all values available in collectd's value cache.
37         rpc ListValues(ListValuesRequest) returns (ListValuesReply);
38 }
39
40 // The arguments to DispatchValues.
41 message DispatchValuesRequest {
42         collectd.types.ValueList values = 1;
43 }
44
45 // The response from DispatchValues.
46 message DispatchValuesReply {
47 }
48
49 // The arguments to ListValues.
50 message ListValuesRequest {
51 }
52
53 // The response from ListValues.
54 message ListValuesReply {
55         message Value {
56                 string name = 1;
57                 google.protobuf.Timestamp time = 2;
58         }
59
60         repeated Value value = 1;
61 }