| OLD | NEW |
| 1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 syntax = "proto3"; | 5 syntax = "proto3"; |
| 6 | 6 |
| 7 package logdog; | 7 package logdog; |
| 8 | 8 |
| 9 import "state.proto"; | 9 import "state.proto"; |
| 10 import "github.com/luci/luci-go/common/proto/logdog/logpb/log.proto"; | 10 import "github.com/luci/luci-go/common/proto/logdog/logpb/log.proto"; |
| 11 import "google/protobuf/duration.proto"; | 11 import "google/protobuf/duration.proto"; |
| 12 import "google/protobuf/empty.proto"; | 12 import "google/protobuf/empty.proto"; |
| 13 | 13 |
| 14 // GetConfigResponse is the response structure for the user | 14 // GetConfigResponse is the response structure for the user |
| 15 // "GetConfig" endpoint. | 15 // "GetConfig" endpoint. |
| 16 message GetConfigResponse { | 16 message GetConfigResponse { |
| 17 // The API URL of the base "luci-config" service. If empty, the default | 17 // The API URL of the base "luci-config" service. If empty, the default |
| 18 // service URL will be used. | 18 // service URL will be used. |
| 19 string config_service_url = 1; | 19 string config_service_url = 1; |
| 20 | 20 |
| 21 // The name of the configuration set to load from. | 21 // The name of the configuration set to load from. |
| 22 string config_set = 2; | 22 string config_set = 2; |
| 23 // The path of the text-serialized configuration protobuf. | 23 // The path of the text-serialized configuration protobuf. |
| 24 string config_path = 3; | 24 string config_path = 3; |
| 25 } | 25 } |
| 26 | 26 |
| 27 // RegisterStreamRequest is the set of caller-supplied data for the | 27 // RegisterStreamRequest is the set of caller-supplied data for the |
| 28 // RegisterStream Coordinator service endpoint. | 28 // RegisterStream Coordinator service endpoint. |
| 29 message RegisterStreamRequest { | 29 message RegisterStreamRequest { |
| 30 // The log stream's project. |
| 31 string project = 1; |
| 30 // The log stream's path. | 32 // The log stream's path. |
| 31 string path = 1; | 33 string path = 2; |
| 32 // The log stream's secret. | 34 // The log stream's secret. |
| 33 bytes secret = 2; | 35 bytes secret = 3; |
| 34 | 36 |
| 35 // The protobuf version string for this stream. | 37 // The protobuf version string for this stream. |
| 36 string proto_version = 3; | 38 string proto_version = 4; |
| 37 // The serialized LogStreamDescriptor protobuf for this stream. | 39 // The serialized LogStreamDescriptor protobuf for this stream. |
| 38 logpb.LogStreamDescriptor desc = 4; | 40 logpb.LogStreamDescriptor desc = 5; |
| 39 } | 41 } |
| 40 | 42 |
| 41 // The response message for the RegisterStream RPC. | 43 // The response message for the RegisterStream RPC. |
| 42 message RegisterStreamResponse { | 44 message RegisterStreamResponse { |
| 43 // The state of the requested log stream. | 45 // The state of the requested log stream. |
| 44 LogStreamState state = 1; | 46 LogStreamState state = 1; |
| 45 | 47 |
| 46 // The log stream's secret. | 48 // The log stream's secret. |
| 47 // | 49 // |
| 48 // Note that the secret is returned! This is okay, since this endpoint is only | 50 // Note that the secret is returned! This is okay, since this endpoint is only |
| 49 // accessible to trusted services. The secret can be cached by services to | 51 // accessible to trusted services. The secret can be cached by services to |
| 50 // validate stream information without needing to ping the Coordinator in | 52 // validate stream information without needing to ping the Coordinator in |
| 51 // between each update. | 53 // between each update. |
| 52 bytes secret = 2; | 54 bytes secret = 2; |
| 53 } | 55 } |
| 54 | 56 |
| 55 // LoadStreamRequest loads the current state of a log stream. | 57 // LoadStreamRequest loads the current state of a log stream. |
| 56 message LoadStreamRequest { | 58 message LoadStreamRequest { |
| 59 // The log stream's project. |
| 60 string project = 1; |
| 57 // The log stream's path. | 61 // The log stream's path. |
| 58 string path = 1; | 62 string path = 2; |
| 59 | 63 |
| 60 // If true, include the log stream descriptor. | 64 // If true, include the log stream descriptor. |
| 61 bool desc = 2; | 65 bool desc = 3; |
| 62 } | 66 } |
| 63 | 67 |
| 64 // The response message for the LoadStream RPC. | 68 // The response message for the LoadStream RPC. |
| 65 message LoadStreamResponse { | 69 message LoadStreamResponse { |
| 66 // The state of the requested log stream. | 70 // The state of the requested log stream. |
| 67 LogStreamState state = 1; | 71 LogStreamState state = 1; |
| 68 | 72 |
| 69 // If requested, the serialized log stream descriptor. The protobuf version | 73 // If requested, the serialized log stream descriptor. The protobuf version |
| 70 // of this descriptor will match the "proto_version" field in "state". | 74 // of this descriptor will match the "proto_version" field in "state". |
| 71 bytes desc = 2; | 75 bytes desc = 2; |
| 72 | 76 |
| 73 // The age of the log stream. | 77 // The age of the log stream. |
| 74 google.protobuf.Duration age = 3; | 78 google.protobuf.Duration age = 3; |
| 75 | 79 |
| 76 // The archival key of the log stream. If this key doesn't match the key in | 80 // The archival key of the log stream. If this key doesn't match the key in |
| 77 // the archival request, the request is superfluous and should be deleted. | 81 // the archival request, the request is superfluous and should be deleted. |
| 78 bytes archival_key = 4; | 82 bytes archival_key = 4; |
| 79 } | 83 } |
| 80 | 84 |
| 81 // TerminateStreamRequest is the set of caller-supplied data for the | 85 // TerminateStreamRequest is the set of caller-supplied data for the |
| 82 // TerminateStream service endpoint. | 86 // TerminateStream service endpoint. |
| 83 message TerminateStreamRequest { | 87 message TerminateStreamRequest { |
| 88 // The log stream's project. |
| 89 string project = 1; |
| 84 // The log stream's path. | 90 // The log stream's path. |
| 85 string path = 1; | 91 string path = 2; |
| 86 // The log stream's secret. | 92 // The log stream's secret. |
| 87 bytes secret = 2; | 93 bytes secret = 3; |
| 88 | 94 |
| 89 // The terminal index of the stream. | 95 // The terminal index of the stream. |
| 90 int64 terminal_index = 3; | 96 int64 terminal_index = 4; |
| 91 } | 97 } |
| 92 | 98 |
| 93 // ArchiveStreamRequest is the set of caller-supplied data for the ArchiveStream | 99 // ArchiveStreamRequest is the set of caller-supplied data for the ArchiveStream |
| 94 // service endpoint. | 100 // service endpoint. |
| 95 message ArchiveStreamRequest { | 101 message ArchiveStreamRequest { |
| 102 // The log stream's project. |
| 103 string project = 1; |
| 96 // The path of the log stream that was archived. | 104 // The path of the log stream that was archived. |
| 97 string path = 1; | 105 string path = 2; |
| 98 // The number of log entries that were archived. | 106 // The number of log entries that were archived. |
| 99 int64 log_entry_count = 2; | 107 int64 log_entry_count = 3; |
| 100 // The highest log stream index that was archived. | 108 // The highest log stream index that was archived. |
| 101 int64 terminal_index = 3; | 109 int64 terminal_index = 4; |
| 102 // If not empty, there was an archival error. | 110 // If not empty, there was an archival error. |
| 103 // | 111 // |
| 104 // This field serves to indicate that an error occured (being non-empty) and | 112 // This field serves to indicate that an error occured (being non-empty) and |
| 105 // to supply an value that will show up in the Coordinator ArchiveStream | 113 // to supply an value that will show up in the Coordinator ArchiveStream |
| 106 // endpoint logs. | 114 // endpoint logs. |
| 107 string error = 4; | 115 string error = 5; |
| 108 | 116 |
| 109 // The archive URL of the log stream's stream data. | 117 // The archive URL of the log stream's stream data. |
| 110 string stream_url = 10; | 118 string stream_url = 10; |
| 111 // The size of the log stream's stream data. | 119 // The size of the log stream's stream data. |
| 112 int64 stream_size = 11; | 120 int64 stream_size = 11; |
| 113 | 121 |
| 114 // The archive URL of the log stream's index data. | 122 // The archive URL of the log stream's index data. |
| 115 string index_url = 20; | 123 string index_url = 20; |
| 116 // The size of the log stream's index data. | 124 // The size of the log stream's index data. |
| 117 int64 index_size = 21; | 125 int64 index_size = 21; |
| (...skipping 19 matching lines...) Expand all Loading... |
| 137 | 145 |
| 138 // TerminateStream is an idempotent operation to update the stream's terminal | 146 // TerminateStream is an idempotent operation to update the stream's terminal |
| 139 // index. | 147 // index. |
| 140 rpc TerminateStream(TerminateStreamRequest) returns (google.protobuf.Empty); | 148 rpc TerminateStream(TerminateStreamRequest) returns (google.protobuf.Empty); |
| 141 | 149 |
| 142 // ArchiveStream is an idempotent operation to record a log stream's archival | 150 // ArchiveStream is an idempotent operation to record a log stream's archival |
| 143 // parameters. It is used by the Archivist service upon successful stream | 151 // parameters. It is used by the Archivist service upon successful stream |
| 144 // archival. | 152 // archival. |
| 145 rpc ArchiveStream(ArchiveStreamRequest) returns (google.protobuf.Empty); | 153 rpc ArchiveStream(ArchiveStreamRequest) returns (google.protobuf.Empty); |
| 146 } | 154 } |
| OLD | NEW |