Additions to agent protocol

livekit / protocol

LiveKit protocol. Protobuf definitions for LiveKit's signaling protocol

https://docs.livekit.io

Apache License 2.0

73 stars 62 forks source link

Additions to agent protocol #717

Closed biglittlebigben closed 3 months ago

biglittlebigben commented 4 months ago

This PR:

Adds StartAgentJobRequest/StopAgentJobRequest calls to start an handle manually mange an agent lifecycle
Deprecates the JobType field in WorkerInfo as workers will now be expected to handle both kinds jobs (if the namespace supports both kinds in the first place)
Adds a metadata string -> string map to Job to allow agent implementation to take anonymous (to us) parameters
Adds a JobStatus and error fields to Job for status reporting (Similar to egress and ingress)
Makes livekit_agent.proto indentation consistent with other proto files
Add room configuration and management APIs to the Room service. Rooms configuration allow bundling most room configuration parameters under a single id, that can eventually be put as part of the room creation token.

changeset-bot[bot] commented 4 months ago

⚠️ No Changeset found

Latest commit: d82084e91279a8f7719d3baa42cef3aaa778bcbd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR

``` Some errors occurred when validating the changesets config: The package or glob expression "github.com/livekit/protocol" specified in the `fixed` option does not match any package in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch. ```

paulwe commented 3 months ago

can we add a field for the number of jobs active during the period the load sample is taken from to the UpdateWorkerStatus message.

what is the process for associating running jobs with a new worker connection when the websocket reconnects? should we expect a flood of MigrateJobRequest messages? maybe that message type should support migrating multiple jobs at once?

biglittlebigben commented 3 months ago

can we add a field for the number of jobs active during the period the load sample is taken from to the UpdateWorkerStatus message.

Added. We have to define what the active Jon count is though: the count at capture time, the max since last capture, ...?

what is the process for associating running jobs with a new worker connection when the websocket reconnects? should we expect a flood of MigrateJobRequest messages? maybe that message type should support migrating multiple jobs at once?

We have not implemented this anywhere yet AFAICT. I did change the message to use a list of ids though.