Skip to content

gRPC API#

log-store uses gRPC for communication between the GUI and the backend. You can communicate directly with the backend via gRPC for searching logs programmatically. gRPC was chosen because it allows APIs to evolve with little disruption through the use of Protocol Buffers.

If you would like to use the gRPC API, please contact log-store for a copy of the latest protobuf files.

log-store API#

log-store currently exposes the following RPC endpoints:

  • Perform a search from web -> frontend, which then proxies to the backend: rpc Search(SearchQuery) returns (SearchResponse) { }
  • Parses a search query, and returns the parsed version: rpc ParseSearch(SearchQuery) returns (query_parser_pb.ParsedSearch) { }
  • Get the number of hits for a search: rpc HitCount(SearchQuery) returns (HitCountResponse) { }
  • Gets the saved searches from the server: rpc GetSavedSearches(GetSavedSearchRequest) returns (GetSavedSearchResponse) { }
  • Saves searches to the server: rpc SetSavedSearches(SetSavedSearchRequest) returns (SetSavedSearchResponse) { }
  • Gets the dashboards: rpc GetDashboards(GetDashboardsRequest) returns (GetDashboardsResponse) { }
  • Saves the dashboards: rpc SetDashboards(SetDashboardsRequest) returns (SetDashboardsResponse) { }