Struct WebServer 

pub struct WebServer {
    pub client: Client,
}

Web Server Service

The web-server service provides a GraphQL gateway to Taskcluster APIs, as well as profiler endpoints that generate Firefox Profiler–compatible profiles from task group metadata and task logs.

Fields

client: Client

The underlying client used to make API calls for this service.

Implementations

impl WebServer

pub fn new<CB: Into<ClientBuilder>>(client_builder: CB) -> Result<Self, Error>

Create a new WebServer instance, based on the given client builder

pub async fn ping(&self) -> Result<(), Error>

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

pub fn ping_url(&self) -> Result<String, Error>

Generate an unsigned URL for the ping endpoint

pub fn ping_signed_url(&self, ttl: Duration) -> Result<String, Error>

Generate a signed URL for the ping endpoint

pub async fn lbheartbeat(&self) -> Result<(), Error>

Load Balancer Heartbeat

Respond without doing anything. This endpoint is used to check that the service is up.

pub fn lbheartbeat_url(&self) -> Result<String, Error>

Generate an unsigned URL for the lbheartbeat endpoint

pub fn lbheartbeat_signed_url(&self, ttl: Duration) -> Result<String, Error>

Generate a signed URL for the lbheartbeat endpoint

pub async fn version(&self) -> Result<(), Error>

Taskcluster Version

Respond with the JSON version object. https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md

pub fn version_url(&self) -> Result<String, Error>

Generate an unsigned URL for the version endpoint

pub fn version_signed_url(&self, ttl: Duration) -> Result<String, Error>

Generate a signed URL for the version endpoint

pub async fn taskGroupProfile(&self, taskGroupId: &str) -> Result<(), Error>

Task Group Profile

Generate a Firefox Profiler–compatible profile from a task group. The profile contains scheduling and execution timing for all tasks.

pub fn taskGroupProfile_url(&self, taskGroupId: &str) -> Result<String, Error>

Generate an unsigned URL for the taskGroupProfile endpoint

pub fn taskGroupProfile_signed_url( &self, taskGroupId: &str, ttl: Duration, ) -> Result<String, Error>

Generate a signed URL for the taskGroupProfile endpoint

pub async fn taskProfile(&self, taskId: &str) -> Result<(), Error>

Task Log Profile

Generate a Firefox Profiler–compatible profile from a task’s log output. Parses public/logs/live.log (or live_backing.log) for timing data.

pub fn taskProfile_url(&self, taskId: &str) -> Result<String, Error>

Generate an unsigned URL for the taskProfile endpoint

pub fn taskProfile_signed_url( &self, taskId: &str, ttl: Duration, ) -> Result<String, Error>

Generate a signed URL for the taskProfile endpoint

pub async fn heartbeat(&self) -> Result<(), Error>

Heartbeat

Respond with a service heartbeat.

This endpoint is used to check on backing services this service depends on.

pub fn heartbeat_url(&self) -> Result<String, Error>

Generate an unsigned URL for the heartbeat endpoint

pub fn heartbeat_signed_url(&self, ttl: Duration) -> Result<String, Error>

Generate a signed URL for the heartbeat endpoint