grpc plugin: Replace the ListValues RPC with QueryValues.
[collectd.git] / proto / collectd.proto
index ba60793..608fcbb 100644 (file)
@@ -1,5 +1,5 @@
 // collectd - proto/collectd.proto
-// Copyright (C) 2015 Sebastian Harl
+// Copyright (C) 2015-2016 Sebastian Harl
 //
 // Permission is hereby granted, free of charge, to any person obtaining a
 // copy of this software and associated documentation files (the "Software"),
@@ -33,8 +33,8 @@ service Collectd {
        // Dispatch collected values to collectd.
        rpc DispatchValues(DispatchValuesRequest) returns (DispatchValuesReply);
 
-       // Retrieve a list of all values available in collectd's value cache.
-       rpc ListValues(ListValuesRequest) returns (ListValuesReply);
+       // Query a list of values available from collectd's value cache.
+       rpc QueryValues(QueryValuesRequest) returns (QueryValuesReply);
 }
 
 // The arguments to DispatchValues.
@@ -46,16 +46,15 @@ message DispatchValuesRequest {
 message DispatchValuesReply {
 }
 
-// The arguments to ListValues.
-message ListValuesRequest {
+// The arguments to QueryValues.
+message QueryValuesRequest {
+       // Query by the fields of the identifier. Only return values matching the
+       // specified shell wildcard patterns (see fnmatch(3)). Use '*' to match
+       // any value.
+       collectd.types.Identifier identifier = 1;
 }
 
-// The response from ListValues.
-message ListValuesReply {
-       message Value {
-               string name = 1;
-               google.protobuf.Timestamp time = 2;
-       }
-
-       repeated Value value = 1;
+// The response from QueryValues.
+message QueryValuesReply {
+       repeated collectd.types.ValueList values = 1;
 }