services.xml - 'admin'

Reference documentation for <admin> in services.xml. Find a working example of this configuration in the sample application multinode-HA services.xml.

admin [version]
    adminserver [hostalias]
    cluster-controllers
        cluster-controller [hostalias, baseport, jvm-options, jvm-gc-options]
    configservers
        configserver [hostalias, baseport]
    logserver [jvm-options, jvm-gc-options]
    slobroks
        slobrok [hostalias, baseport]
    monitoring [systemname]
    metrics
        consumer [id]
            metric-set [id]
            metric [id]
            cloudwatch [region, namespace]
                shared-credentials [file, profile]
    logging

adminserver

The configured node will be the default administration node in your Vespa system, which means that unless configured otherwise all administrative services - i.e. the log server, the configuration server, the slobrok, and so on - will run on this node. Use configservers, logserver, slobroks elements if you need to specify baseport or jvm options for any of these services.

cluster-controllers

Container for one or more cluster-controller elements. When having one or more content clusters, configuring at least one cluster controller is required.

cluster-controller

Specifies a host on which to run the Cluster Controller service. The Cluster Controller manages the state of the cluster in order to provide elasticity and failure detection.

configservers

Container for one or more configserver elements.

configserver

Specifies a host on which to run the Configuration Server service. If contained directly below <admin> you may only have one, so if you need to configure multiple instances of this service, contain them within the <configservers> element.

logserver

Specifies a host on which to run the Vespa Log Server service. If not specified, the logserver is placed on the adminserver, like in the example.

Example:

<logserver hostalias="node1" />

slobroks

This is a container for one or more slobrok elements.

slobrok

Specifies a host on which to run the Service Location Broker (slobrok) service.

monitoring

Settings for how to pass metrics to a monitoring service - see monitoring.

<monitoring systemname="name-in-metrics-system" />

logging

Used for tuning log levels of Java plug-ins. If you (temporarily) need to enable debug logging from some class or package, or if some third-party component is spamming your log with unnecessary INFO level messages, you can turn levels on or off. Example:

<logging>
    <class name="org.myorg.MyHelperClass" levels="+debug" />
    <class name="org.thirdparty.TooSpammyClass" levels="-info" />
    <package name="org.myorg.tricky.package" levels="all" />
    <package name="org.anotherorg" levels="all -info -debug -spam" />
</logging>

Note that tuning also affects sub-packages, so the above would also affect all packages with org.anotherorg. as prefix. And if there is a org.myorg.tricky.package.foo.InternalClass you will get even "spam" level logging from it!

The default for levels is "all -debug -spam" and as seen above you can add and remove specific levels.

metrics

Used for configuring the forwarding of metrics to graphing applications - add consumer child elements. Also see monitoring. Example:

<metrics>
    <consumer id="my-metric-namespace">
        <metric-set id="default" />
        <metric id="my-custom-metric" />
        <cloudwatch region="us-east-1" namespace="my-vespa">
            <shared-credentials file="/path/to/credentials-file" profile="default" />
        </cloudwatch>
    </consumer>
</metrics>

consumer

Configure a metrics consumer. The metrics contained in this element will be exported to the consumer with the given id. consumer is a request parameter in /metrics/v1/values, /metrics/v2/values and /prometheus/v1/values.

Add metric and/or metric-set children.

metric-set

Include a pre-defined set of metrics to the consumer.

metric

Configure a metric.

Note that metric id needs to include the metric specific suffix, e.g. .average.

In this example, there is one metric added to a custom consumer in addition to the default metric set. Use &consumer=my-custom-consumer parameter for the prometheus endpoint. Also notice the .count suffix, see process metrics api.

The per process metrics api endpoint /state/v1/metrics also includes a description of each emitted metric. The /state/v1/metrics endpoint also includes the metric aggregates (.count, .average, .rate, .max).

<metrics>
    <consumer id="my-custom-consumer">
        <metric-set id="default" />
        <metric id="vds.idealstate.garbage_collection.documents_removed.count" />
    </consumer>
</metrics>

cloudwatch

Specifies that the metrics from this consumer should be forwarded to CloudWatch.

Example:

<cloudwatch region="us-east-1" namespace="my-vespa">
    <shared-credentials file="/path/to/credentials-file" profile="default" />
</cloudwatch>

shared-credentials

Specifies that a profile from a shared-credentials file should be used for authentication to CloudWatch.