HTTP ๐
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
http
monitor type to generate metrics based on whether the HTTP
response from the configured URL matches expectations. For example,
correct body, status code, and so on.
Note
To monitor HTTP endpoints with the OpenTelemetry Collector using native OpenTelemetry components refer to the HTTP check receiver.
If applicable, TLS information is automatically fetched from the base
URL or redirection, depending on whether the useHTTPS
parameter is
configured.
Benefits ๐
After you configure the integration, you can access these features:
View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata catalog.
Setup ๐
To create a webcheck from a URL, split the URL into different
configuration options. All of these options determine the URL dimension
value from its โnormalizedโ URL, which is in the format of
{scheme}://{host}:{port}{path}
:
scheme
ishttps
ifuseHTTPS:true
, orhttp
ifuseHTTPS:false
.host
is the host name of the site to check. This option is required.port
is the port to connect to. If not defined,port
is443
ifuseHTTPS:true
or80
ifuseHTTPS:false
. The default value forhttp
is80
. If the default value is used,port
is removed from the configuration because it is implicit and makes the behavior similar to whatcurl
does.path
contains the full query including the resource path and finally theGET
method parameters with?
separator.
Configure the following options to change the behavior of the request done on this URL:
Configure the
method
option to define request types such asGET
orPOST
. See https://golang.org/src/net/http/method.go for the full list of available methods.Configure the
username
andpassword
options for basic authentication.Configure the
httpHeaders
option to define request headers. Use this option to override thehost
header.Configure the
requestBody
option to provide a body to the request. The form of this body depends on theContent-Type
header. For example,{"foo":"bar"}
withContent-Type: application/json
.Configure the
noRedirects:false
option to stop the URL from following redirects. The default value istrue
.
See configuration examples for different request behaviors.
The following configuration options change the resulting values:
The
desiredCode
option determines thehttp.code_matched
value. Configure this option if you expect a different โnormalโ value. The default value is200
. For example, configuredesiredCode:301
andnoRedirects:false
to check a redirect (and not the end redirected URL) keeping the value to1
(success).The
regex
option does the same with thehttp.regex_matched
metric, where the value is1
only if the provided regex matches the response body.The
addRedirectURL
option does not have impact on metrics, but adds a new dimensionredirect_url
with a โdynamicโ value. If theurl
dimension changes with the monitor configuration, theredirect_url
value is impacted by any server change and is always the last URL redirected. This option is deactivated by default because this could cause issues with heartbeat detectors, for example.
The following HTTP headers let the client and the server pass additional information with an HTTP request or response:
Cache-Control: no-cache
to send the request to the origin server for validation before releasing a cached copy.Host
to change the request, that is, to bypass CDN or load balancer requesting directly the back end.Content-Type
to indicate the media type of the resource. For example,json
,xml
, oroctet-stream
.
Installation ๐
Follow these steps to deploy this integration:
Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the integration, as described in the Configuration section.
Restart the Splunk Distribution of the OpenTelemetry Collector.
Configuration ๐
To use this integration of a Smart Agent monitor with the Collector:
Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.
Example ๐
To activate this integration, add the following to your Collector configuration:
receivers:
smartagent/http:
type: http
... # Additional config
Next, add the monitor to the service.pipelines.metrics.receivers
section of your configuration file:
service:
pipelines:
metrics:
receivers: [smartagent/http]
Monitor multiple hosts ๐
To monitor multiple hosts, add an http
monitor entry for each host
in the receivers
section of the configuration. For example:
receivers:
smartagent/host1:
type: http
... # Additional config for host 1
smartagent/host2:
type: http
... # Additional config for host 2
Next, add the monitor to the service.pipelines.metrics.receivers
section of your configuration file:
service:
pipelines:
metrics:
receivers: [smartagent/host1, smartagent/host2]
Configuration options ๐
The following table shows the configuration options for this monitor:
Option |
Required |
Type |
Description |
---|---|---|---|
|
no |
|
|
|
no |
|
|
|
no |
|
The HTTP path to use in the test request. |
|
no |
|
|
|
no |
|
The basic auth username to use on each request, if any. |
|
no |
|
The basic auth password to use on each request, if any. |
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
Do not follow redirect. The default value is |
|
no |
|
HTTP request method to use. The default value is |
|
no |
|
|
|
no |
|
Optional regex to match on URL(s) response(s). |
|
no |
|
|
|
no |
|
|
Metrics ๐
These are the metrics available for this integration:
Notes ๐
To learn more about the available in Splunk Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure
extraMetrics
in Add additional metrics
Troubleshooting ๐
If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.
Available to Splunk Observability Cloud customers
Submit a case in the Splunk Support Portal .
Contact Splunk Support .
Available to prospective customers and free trial users
Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.