package fleetspeak.server

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc BlacklistClient (BlacklistClientRequest, EmptyMessage)

  admin.proto:203

  BlacklistClient marks a client_id as invalid, forcing all Fleetspeak clients using it to rekey.

  message BlacklistClientRequest

  admin.proto:127

  • bytes client_id = 1

• rpc CreateBroadcast (CreateBroadcastRequest, EmptyMessage)

  admin.proto:144

  CreateBroadcast creates a FS broadcast, potentially sending a message to many machines in the fleet.

  message CreateBroadcastRequest

  admin.proto:12

  • optional Broadcast broadcast = 1

  • uint64 limit = 2

• rpc DeleteFile (DeleteFileRequest, EmptyMessage)

  admin.proto:196

  DeleteFile deletes a file from the Fleetspeak system.

  message DeleteFileRequest

  admin.proto:99

  • string service_name = 1

  • string file_name = 2

• rpc DeletePendingMessages (DeletePendingMessagesRequest, EmptyMessage)

  admin.proto:181

  DeletePendingMessages clears message queues for given clients.

  message DeletePendingMessagesRequest

  admin.proto:65

  • repeated bytes client_ids = 1

• rpc DisableBroadcasts (DisableBroadcastsRequest, EmptyMessage)

  admin.proto:152

  DisableBroadcasts explicitly disables FS broadcasts.

  message DisableBroadcastsRequest

  admin.proto:26

  • repeated bytes broadcast_ids = 1

• rpc FetchClientResourceUsageRecords (FetchClientResourceUsageRecordsRequest, FetchClientResourceUsageRecordsResponse)

  admin.proto:208

  FetchClientResourceUsageRecords returns all resource usage records for a single client with a given limit on the number of records.

  message FetchClientResourceUsageRecordsRequest

  admin.proto:131

  • bytes client_id = 1

  • optional google.protobuf.Timestamp start_timestamp = 3

  • optional google.protobuf.Timestamp end_timestamp = 4

  message FetchClientResourceUsageRecordsResponse

  admin.proto:137

  • repeated ClientResourceUsageRecord records = 1

• rpc GetMessageStatus (GetMessageStatusRequest, GetMessageStatusResponse)

  admin.proto:171

  GetMessageStatus retrieves the current status of a message.

  message GetMessageStatusRequest

  admin.proto:61

  • bytes message_id = 1

  message GetMessageStatusResponse

  admin.proto:88

  • optional google.protobuf.Timestamp creation_time = 1

  • optional MessageResult result = 2

• rpc GetPendingMessageCount (GetPendingMessageCountRequest, GetPendingMessageCountResponse)

  admin.proto:189

  Returns the number of pending messages for the given clients.

  message GetPendingMessageCountRequest

  admin.proto:80

  • repeated bytes client_ids = 1

  message GetPendingMessageCountResponse

  admin.proto:84

  • uint64 count = 1

• rpc GetPendingMessages (GetPendingMessagesRequest, GetPendingMessagesResponse)

  admin.proto:185

  Returns the pending messages for given clients.

  message GetPendingMessagesRequest

  admin.proto:69

  • repeated bytes client_ids = 1

  • uint64 offset = 2

  • uint64 limit = 3

  • bool want_data = 4

  message GetPendingMessagesResponse

  admin.proto:76

  • repeated Message messages = 1

• rpc InsertMessage (Message, EmptyMessage)

  admin.proto:178

  InsertMessage 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 KeepAlive (EmptyMessage, EmptyMessage)

  admin.proto:199

  KeepAlive does as little as possible.

• rpc ListActiveBroadcasts (ListActiveBroadcastsRequest, ListActiveBroadcastsResponse)

  admin.proto:148

  ListActiveBroadcasts lists the currently active FS broadcasts.

  message ListActiveBroadcastsRequest

  admin.proto:17

  • string service_name = 1

    If set, only return broadcasts with the given service_name.

  message ListActiveBroadcastsResponse

  admin.proto:22

  • repeated Broadcast broadcasts = 1

• rpc ListClientContacts (ListClientContactsRequest, ListClientContactsResponse)

  admin.proto:163

  ListClientContacts lists the contact history for a client.

  message ListClientContactsRequest

  admin.proto:104

  • bytes client_id = 1

  message ListClientContactsResponse

  admin.proto:108

  • repeated ClientContact contacts = 1

• rpc ListClients (ListClientsRequest, ListClientsResponse)

  admin.proto:156

  ListClients lists the currently active FS clients.

  message ListClientsRequest

  admin.proto:30

  • repeated 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 ListClientsResponse

  admin.proto:36

  • repeated Client clients = 1

• rpc StoreFile (StoreFileRequest, EmptyMessage)

  admin.proto:193

  StoreFile inserts a file into the Fleetspeak system.

  message StoreFileRequest

  admin.proto:93

  • string service_name = 1

  • string file_name = 2

  • bytes data = 3

• rpc StreamClientContacts (StreamClientContactsRequest, stream StreamClientContactsResponse)

  admin.proto:167

  StreamClientContacts lists the contact history for a client as a stream.

  message StreamClientContactsRequest

  admin.proto:112

  • bytes client_id = 1

  message StreamClientContactsResponse

  admin.proto:116

  • optional ClientContact contact = 1

• rpc StreamClientIds (StreamClientIdsRequest, stream StreamClientIdsResponse)

  admin.proto:159

  StreamClientIds lists the currently active FS clients as a stream.

  message StreamClientIdsRequest

  admin.proto:40

  • bool include_blacklisted = 1

  • optional google.protobuf.Timestamp last_contact_after = 2

  message StreamClientIdsResponse

  admin.proto:45

  • bytes client_id = 1

A Broadcast is a template to build messages to send to a number of machines.

Used in: CreateBroadcastRequest, ListActiveBroadcastsResponse

• bytes broadcast_id = 1

  8 byte id of the broadcast. Randomly generated if unset at creation time.

• optional Address source = 2

  The source of the broadcast, must be a server side service.

• optional Address destination = 7

  The destination of the broadcast, must be a client side service. The client_id of the destination is ignored and overwritten with any client that is eligible to receive the broadcast. If unset, the broadcast will be addressed to a client service with the same name as the source.

• string message_type = 3

  The message type of the payload.

• repeated Label required_labels = 4

  A client will only be sent this broadcast if it has been marked with all of the required labels. Note: All labels (installed+generated) are usually set by the "client" service.

• optional google.protobuf.Timestamp expiration_time = 5

  A broadcast will stop being sent at this time.

• optional google.protobuf.Any data = 6

  The payload of the broadcast.

• string group_name = 8

  An optional group name that the broadcast gets categorized under. If set, this broadcast will replace older broadcasts with the same group, source, destination, and required labels on creation. This effectively causes clients to only receive the latest broadcast in the same group.

Next unused tag: 8

Used in: ListClientsResponse

• bytes client_id = 1

• repeated Label labels = 2

• optional google.protobuf.Timestamp last_contact_time = 3

• string last_contact_address = 4

• string last_contact_streaming_to = 7

• optional google.protobuf.Timestamp last_clock = 5

• bool blacklisted = 6

Used in: ListClientContactsResponse, StreamClientContactsResponse

• fixed64 sent_nonce = 1

• fixed64 received_nonce = 2

• string observed_address = 3

• optional google.protobuf.Timestamp timestamp = 4

Represents client resource-usage data in the data-store. Next id: 15

Used in: FetchClientResourceUsageRecordsResponse

• 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 google.protobuf.Timestamp process_start_time = 3

• optional google.protobuf.Timestamp client_timestamp = 4

  When the resource-usage metrics were measured on the client.

• optional google.protobuf.Timestamp 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

Describes 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 ServiceConfig services = 1

  The collection of services that this server should include.

• optional google.protobuf.Duration broadcast_poll_time = 2

  The approximate time to wait between checking for new broadcasts. If unset, a default of 1 minute is used.

A ServiceConfig describes how the server should configure a 'service', which is a module that sends and processes messages.

Used in: ServerConfig

• 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 google.protobuf.Any config = 4

  Additional configuration information for the factory to use when setting up the service. The allowed type depends upon the factory.