StatusRestController

Implements: RestController

Description

The StatusRestController class allows you to create a controller that returns microservice status information via the HTTP/REST protocol.

The controller responds on /status route (can be changed) with a JSON object:
{
    - "id":            unique container id (usually hostname)
    - "name":          container name (from ContextInfo)
    - "description":   container description (from ContextInfo)
    - "start_time":    time when container was started
    - "current_time":  current time in UTC
    - "uptime":        duration since container start time in milliseconds
    - "properties":    additional container properties (from ContextInfo)
    - "components":    descriptors of components registered in the container
}

Configuration parameters

• base_route: base route for remote URI
• route: status route (default: “status”)
• dependencies:
  • endpoint: override for HTTP Endpoint dependency
  • controller: override for Controller dependency
• connection(s):
  • discovery_key: (optional) key to retrieve the connection from IDiscovery
  • protocol: connection protocol (http or https)
  • host: host name or IP address
  • port: port number
  • uri: resource URI or connection string with all parameters in it

References

• *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
• *:counters:*:*:1.0 - (optional) ICounters components to pass collected measurements
• *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connection
• *:endpoint:http:*:1.0 - (optional) HttpEndpoint reference

Constructors

NewStatusRestService

NewStatusRestService() *StatusRestService

Methods

Configure

Configures the component by passing its configuration parameters.

(c *StatusRestService) Configure(ctx context.Context, config *cconf.ConfigParams)

• ctx: context.Context - operation context.
• config: *cconf.ConfigParams - configuration parameters to be set.

SetReferences

Sets references to dependent components.

(c *StatusRestService) SetReferences(ctx context.Context, references crefer.IReferences)

• ctx: context.Context - operation context.
• references: crefer.IReferences - references to locate the component dependencies.

Register

Registers all service routes in HTTP endpoint.

(c *StatusRestController) Register()

Examples

service = NewStatusService();
service.Configure(context.Background(), cref.NewConfigParamsFromTuples(
	"connection.protocol", "http",
	"connection.host", "localhost",
	"connection.port", 8080,
))

opnErr:= service.Open(context.Background(), "123")
if opnErr == nil {
	fmt.Println("The Status service is accessible at http://localhost:8080/status")
}

See also

• RestClient

• RestController