proto/collectd.proto

   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
  25 syntax = "proto3";
  26
  27 package collectd;
  28
  29 import "types.proto";
  30
  31 service Collectd {
  32         // Dispatch collected values to collectd.
  33         rpc DispatchValues(DispatchValuesRequest) returns (DispatchValuesReply);
  34
  35         // Query a list of values available from collectd's value cache.
  36         rpc QueryValues(QueryValuesRequest) returns (QueryValuesReply);
  37 }
  38
  39 // The arguments to DispatchValues.
  40 message DispatchValuesRequest {
  41         collectd.types.ValueList values = 1;
  42 }
  43
  44 // The response from DispatchValues.
  45 message DispatchValuesReply {
  46 }
  47
  48 // The arguments to QueryValues.
  49 message QueryValuesRequest {
  50         // Query by the fields of the identifier. Only return values matching the
  51         // specified shell wildcard patterns (see fnmatch(3)). Use '*' to match
  52         // any value.
  53         collectd.types.Identifier identifier = 1;
  54 }
  55
  56 // The response from QueryValues.
  57 message QueryValuesReply {
  58         repeated collectd.types.ValueList values = 1;
  59 }