Package dev.dokimos.server.client

Class DokimosServerReporter

java.lang.Object

dev.dokimos.server.client.DokimosServerReporter

All Implemented Interfaces:

Reporter, AutoCloseable

public class DokimosServerReporter
extends Object
implements Reporter

An async HTTP implementation of Reporter that sends experiment results to a Dokimos server.

Items are queued and sent in batches by a background thread to reduce HTTP overhead. Batches are sent when either 10 items are queued or 500ms have passed since the first item in the batch.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DokimosServerReporter.Builder	Builder for DokimosServerReporter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_API_VERSION	The default API version used when not explicitly specified.

Method Summary

Modifier and Type	Method	Description
static DokimosServerReporter.Builder	builder()	Creates a new builder for DokimosServerReporter.
void	close()	Flushes pending items and releases resources.
void	completeRun(RunHandle handle, RunStatus status)	Marks a run as complete.
void	flush()	Blocks until all pending items are sent.
static DokimosServerReporter	fromEnvironment()	Creates a reporter from environment variables.
void	reportItem(RunHandle handle, ItemResult result)	Reports a single evaluated item.
RunHandle	startRun(String experimentName, Map<String,Object> metadata)	Starts a new experiment run.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_API_VERSION

public static final String DEFAULT_API_VERSION

The default API version used when not explicitly specified.

See Also:

• Constant Field Values

Method Details

builder

public static DokimosServerReporter.Builder builder()

Creates a new builder for DokimosServerReporter.

Returns:

a new builder

fromEnvironment

public static DokimosServerReporter fromEnvironment()

Creates a reporter from environment variables.

Reads DOKIMOS_SERVER_URL and DOKIMOS_PROJECT_NAME from the environment. Optionally reads DOKIMOS_API_KEY for authentication and DOKIMOS_API_VERSION for version pinning.

Returns:

a configured reporter

Throws:

IllegalStateException - if required environment variables are not set

startRun

public RunHandle startRun(String experimentName,
 Map<String,Object> metadata)

Description copied from interface: Reporter

Starts a new experiment run.

Specified by:

startRun in interface Reporter

Parameters:

experimentName - the name of the experiment

metadata - configuration metadata for the run

Returns:

a handle identifying this run

reportItem

public void reportItem(RunHandle handle,
 ItemResult result)

Description copied from interface: Reporter

Reports a single evaluated item.

This is called after each item completes evaluation, not batched at the end.

Specified by:

reportItem in interface Reporter

Parameters:

handle - the run handle from Reporter.startRun(java.lang.String, java.util.Map<java.lang.String, java.lang.Object>)

result - the evaluated item result

completeRun

public void completeRun(RunHandle handle,
 RunStatus status)

Description copied from interface: Reporter

Marks a run as complete.

Specified by:

completeRun in interface Reporter

Parameters:

handle - the run handle from Reporter.startRun(java.lang.String, java.util.Map<java.lang.String, java.lang.Object>)

status - the final status of the run

flush

public void flush()

Description copied from interface: Reporter

Blocks until all pending items are sent.

This is important for async implementations to ensure all data is transmitted before the experiment returns.

Specified by:

flush in interface Reporter

close

public void close()

Description copied from interface: Reporter

Flushes pending items and releases resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Reporter