Http-get¶

The http-get resource allows fetching remote resources with HTTP GET http:// URI schema. It is not meant to be instantiated directly. Once configured, user can request a resource through org.voltdb.stream.api.resources.FileAccess#getData call.

JAVAYAML

.configureResource(HttpGetResourceConfigBuilder.builder()
)

resource:
  http-get:

Java dependency management¶

Add this declaration to your dependency management system to access the configuration DSL for this plugin in Java.

MavenGradle

<dependency>
    <groupId>org.voltdb</groupId>
    <artifactId>volt-stream-plugin-http-api</artifactId>
    <version>1.8.0</version>
</dependency>

implementation group: 'org.voltdb', name: 'volt-stream-plugin-http-api', version: '1.8.0'

JSON Schema¶

You can validate or explore the configuration using its JSON Schema.

Usage Examples¶

JAVAYAML

// HTTP resource is automatically registered and available
// No explicit configuration needed for basic usage
HttpResourceConfigBuilder.builder().build();

resources:
    - name: http-client
      http-get: {}

source:
    stdin: {}

sink:
    stdout: {}

Metrics¶

Http metrics¶

Metric enum: org.voltdb.stream.plugin.http.HttpMetric

Prometheus name	Type	Description
`voltsp_http_buffer_capacity_total`	`gauge`	Remaining HTTP source message buffer capacity.
`voltsp_http_connection_attempt_total`	`counter`	Number of HTTP sink connection attempts.
`voltsp_http_connection_error_total`	`counter`	Number of HTTP sink connection errors.
`voltsp_http_connection_timeout_total`	`counter`	Number of HTTP sink connection timeouts.
`voltsp_http_exceeded_payload_size_total`	`counter`	Number of HTTP requests rejected for exceeding the configured payload size.
`voltsp_http_idle_timeout_total`	`counter`	Number of HTTP idle connection timeouts.
`voltsp_http_internal_errors_total`	`counter`	Number of HTTP source internal errors.
`voltsp_http_invalid_media_type_total`	`counter`	Number of HTTP requests rejected for invalid media type.
`voltsp_http_invalid_path_total`	`counter`	Number of HTTP requests rejected for invalid path.
`voltsp_http_invalid_request_method_total`	`counter`	Number of HTTP requests rejected for invalid method.
`voltsp_http_received_bytes`	`counter`	Number of HTTP request body bytes received by the source.
`voltsp_http_received_requests_total`	`counter`	Number of HTTP requests received by the source.
`voltsp_http_request_acknowledged_total`	`counter`	Number of HTTP sink requests acknowledged.
`voltsp_http_request_failed_total`	`counter`	Number of failed HTTP sink requests.
`voltsp_http_response_code_2xx_total`	`counter`	Number of HTTP sink responses with a 2xx status code.
`voltsp_http_response_code_3xx_total`	`counter`	Number of HTTP sink responses with a 3xx status code.
`voltsp_http_response_code_4xx_total`	`counter`	Number of HTTP sink responses with a 4xx status code.
`voltsp_http_response_code_5xx_total`	`counter`	Number of HTTP sink responses with a 5xx status code.
`voltsp_http_request_round_trip_time_seconds`	`histogram`	HTTP sink request round-trip duration.