package fleetspeak.server
Get desktop application:
View/edit binary Protocol Buffers messages
service Admin
admin.proto:132rpc CreateBroadcast (, )
admin.proto:135CreateBroadcast creates a FS broadcast, potentially sending a message to many machines in the fleet.
message
admin.proto:12optional broadcast = 1
uint64 limit = 2
rpc ListActiveBroadcasts (, )
admin.proto:139ListActiveBroadcasts lists the currently active FS broadcasts.
message
admin.proto:17string service_name = 1
If set, only return broadcasts with the given service_name.
message
admin.proto:22repeated broadcasts = 1
rpc ListClients (, )
admin.proto:143ListClients lists the currently active FS clients.
message
admin.proto:26repeated bytes client_ids = 1
If non-empty, restricts results to the listed client_ids. If empty, all clients known to the system will be listed.
message
admin.proto:32repeated clients = 1
rpc StreamClientIds (, stream )
admin.proto:146StreamClientIds lists the currently active FS clients as a stream.
message
admin.proto:36bool include_blacklisted = 1
optional last_contact_after = 2
message
admin.proto:41bytes client_id = 1
rpc ListClientContacts (, )
admin.proto:150ListClientContacts lists the contact history for a client.
message
admin.proto:95bytes client_id = 1
message
admin.proto:99repeated contacts = 1
rpc StreamClientContacts (, stream )
admin.proto:154StreamClientContacts lists the contact history for a client as a stream.
message
admin.proto:103bytes client_id = 1
message
admin.proto:107optional contact = 1
rpc GetMessageStatus (, )
admin.proto:158GetMessageStatus retrieves the current status of a message.
message
admin.proto:57bytes message_id = 1
message
admin.proto:84optional creation_time = 1
optional result = 2
rpc InsertMessage (, )
admin.proto:165InsertMessage inserts a message into the Fleetspeak system to be processed by the server or delivered to a client. TODO: Have this method return the message that is written to the datastore (or at least the id).
rpc DeletePendingMessages (, )
admin.proto:168DeletePendingMessages clears message queues for given clients.
message
admin.proto:61repeated bytes client_ids = 1
rpc GetPendingMessages (, )
admin.proto:172Returns the pending messages for given clients.
message
admin.proto:65repeated bytes client_ids = 1
uint64 offset = 2
uint64 limit = 3
bool want_data = 4
message
admin.proto:72repeated messages = 1
Returns the number of pending messages for the given clients.
message
admin.proto:76repeated bytes client_ids = 1
message
admin.proto:80uint64 count = 1
rpc StoreFile (, )
admin.proto:180StoreFile inserts a file into the Fleetspeak system.
message
admin.proto:89string service_name = 1
string file_name = 2
bytes data = 3
rpc KeepAlive (, )
admin.proto:183KeepAlive does as little as possible.
rpc BlacklistClient (, )
admin.proto:187BlacklistClient marks a client_id as invalid, forcing all Fleetspeak clients using it to rekey.
message
admin.proto:118bytes client_id = 1
FetchClientResourceUsageRecords returns all resource usage records for a single client with a given limit on the number of records.
message
admin.proto:122bytes client_id = 1
optional start_timestamp = 3
optional end_timestamp = 4
message
admin.proto:128repeated records = 1
message
broadcasts.proto:12A Broadcast is a template to build messages to send to a number of machines.
Used in: ,
bytes broadcast_id = 1
optional source = 2
The source of the broadcast, it should only be a server side service. The destinations for the resulting broadcast messages will be different clients with the same service name.
string message_type = 3
repeated required_labels = 4
A client will only be sent this broadcast if it has been marked with all of the required labels.
optional expiration_time = 5
A broadcast will stop being sent at this time.
optional data = 6
message
admin.proto:45Next unused tag: 8
Used in:
bytes client_id = 1
repeated labels = 2
optional last_contact_time = 3
string last_contact_address = 4
string last_contact_streaming_to = 7
optional last_clock = 5
bool blacklisted = 6
message
admin.proto:111Used in: ,
fixed64 sent_nonce = 1
fixed64 received_nonce = 2
string observed_address = 3
optional timestamp = 4
message
resource.proto:11Represents client resource-usage data in the data-store. Next id: 15
Used in:
string scope = 1
Name of the client service that resource usage is charged/attributed to e.g 'system' for the system Fleetspeak service, or the name of a daemon service as specified in its config.
int64 pid = 2
optional process_start_time = 3
optional client_timestamp = 4
When the resource-usage metrics were measured on the client.
optional server_timestamp = 5
When the resource usage record was written to the data-store.
bool process_terminated = 12
If true, indicates that the process has terminated, and that this is the final resource-usage record for that process.
float mean_user_cpu_rate = 6
CPU-usage is in millis per second.
float max_user_cpu_rate = 7
float mean_system_cpu_rate = 8
float max_system_cpu_rate = 9
int32 mean_resident_memory_mib = 10
int32 max_resident_memory_mib = 11
int32 mean_num_fds = 13
int32 max_num_fds = 14
message
server.proto:13Describes a server's configuration. If unset, all values default to values reasonable for a unit test or small installation. Larger installations may need to tune these.
repeated services = 1
The collection of services that this server should include.
optional broadcast_poll_time = 2
The approximate time to wait between checking for new broadcasts. If unset, a default of 1 minute is used.
message
services.proto:11A ServiceConfig describes how the server should configure a 'service', which is a module that sends and processes messages.
Used in:
string name = 1
The name that the service will be known as. Primary use is to address messages to the service. The service names 'server' and 'client' are reserved.
string factory = 2
The name of the factory which will be used to generate the service.
uint32 max_parallelism = 3
The maximum number of simultaneous calls to the service's ProcessMessage method. If unset, defaults to 100.
optional config = 4
Additional configuration information for the factory to use when setting up the service. The allowed type depends upon the factory.