OLD | NEW |
---|---|
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 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 logpb; | 7 package logpb; |
8 | 8 |
9 import "log.proto"; | 9 import "log.proto"; |
10 import "google/protobuf/timestamp.proto"; | 10 import "google/protobuf/timestamp.proto"; |
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
70 * same log stream. | 70 * same log stream. |
71 */ | 71 */ |
72 message Entry { | 72 message Entry { |
73 /* | 73 /* |
74 * The descriptor for this entry's log stream. | 74 * The descriptor for this entry's log stream. |
75 * | 75 * |
76 * Each LogEntry in the "logs" field is shares this common descriptor. | 76 * Each LogEntry in the "logs" field is shares this common descriptor. |
77 */ | 77 */ |
78 logpb.LogStreamDescriptor desc = 1; | 78 logpb.LogStreamDescriptor desc = 1; |
79 | 79 |
80 /* | 80 /* (DEPRECATED) Per-entry secret replaced with Butler-wide secret. */ |
81 * The log prefix's secret value (required). | 81 bytes deprecated_entry_secret = 2; |
82 * | |
83 * The secret is generated by the Butler and unique to this specific log | |
84 * stream. The Coordinator will record the secret associated with a given | |
85 * log Prefix/Stream, but will not share the secret with a client. | |
86 * | |
87 * The Collector will check the secret prior to ingesting logs. If the | |
88 * secret doesn't match the value recorded by the Coordinator, the log | |
89 * will be discarded. | |
90 * | |
91 * This ensures that only the Butler instance that generated the log stream | |
92 * can emit log data for that stream. | |
93 */ | |
94 bytes secret = 2; | |
95 | 82 |
96 /* | 83 /* |
97 * Whether this log entry terminates its stream. | 84 * Whether this log entry terminates its stream. |
98 * | 85 * |
99 * If present and "true", this field declares that this Entry is the last | 86 * If present and "true", this field declares that this Entry is the last |
100 * such entry in the stream. This fact is recorded by the Collector and | 87 * such entry in the stream. This fact is recorded by the Collector and |
101 * registered with the Coordinator. The largest stream prefix in this Entry | 88 * registered with the Coordinator. The largest stream prefix in this Entry |
102 * will be bound the stream's LogEntry records to [0:largest_prefix]. Once | 89 * will be bound the stream's LogEntry records to [0:largest_prefix]. Once |
103 * all messages in that range have been received, the log may be archived. | 90 * all messages in that range have been received, the log may be archived. |
104 * | 91 * |
(...skipping 13 matching lines...) Expand all Loading... | |
118 * | 105 * |
119 * This is the main log entry content. | 106 * This is the main log entry content. |
120 */ | 107 */ |
121 repeated logpb.LogEntry logs = 5; | 108 repeated logpb.LogEntry logs = 5; |
122 } | 109 } |
123 | 110 |
124 /** | 111 /** |
125 * Each Entry is an individual set of log records for a given log stream. | 112 * Each Entry is an individual set of log records for a given log stream. |
126 */ | 113 */ |
127 repeated Entry entries = 3; | 114 repeated Entry entries = 3; |
115 | |
116 /** Project specifies which luci-config project this stream belongs to. */ | |
117 string project = 4; | |
118 | |
119 /** | |
120 * The log stream prefix that is shared by all bundled streams. | |
121 * | |
122 * This prefix is valid within the supplied project scope. | |
123 */ | |
124 string prefix = 5; | |
125 | |
126 /* | |
127 * The log prefix's secret value (required). | |
128 * | |
129 * The secret is bound to all log streams that share the supplied Prefix, and | |
130 * The Coordinator will record the secret associated with a given log Prefix, | |
131 but will not share the secret with a client. | |
Vadim Sh.
2016/04/25 18:51:52
also, who exactly is meant by "a client" here? Log
Vadim Sh.
2016/04/25 18:51:52
nit: add "* " :)
| |
132 * | |
133 * The Collector will check the secret prior to ingesting logs. If the | |
134 * secret doesn't match the value recorded by the Coordinator, the log | |
135 * will be discarded. | |
136 * | |
137 * This ensures that only the Butler instance that generated the log stream | |
Vadim Sh.
2016/04/25 18:51:52
Is knowing secret alone sufficient to push message
dnj
2016/04/25 19:30:26
The secret is:
- At the moment, generated by this
| |
138 * can emit log data for that stream. It also ensures that only authenticated | |
139 * users can write to a Prefix. | |
140 */ | |
141 bytes secret = 6; | |
128 } | 142 } |
OLD | NEW |