{{- generatedHeader }} {{/* This template can be used as a starting point for writing documentation for your new integration. For each section, fill in the details described in the comments.

Find more detailed documentation guidelines in https://www.elastic.co/docs/extend/integrations/documentation-guidelines */}}

EfficientIP DDI Logging Integration for Elastic

Overview

{{/* Complete this section with a short summary of what data this integration collects and what use cases it enables */}} The EfficientIP DDI Logging integration for Elastic enables collection of ... This integration facilitates ...

Compatibility

{{/* Complete this section with information on what 3rd party software or hardware versions this integration is compatible with */}} This integration is compatible with ...

How it works

{{/* Add a high level overview on how this integration works. For example, does it collect data from API calls or recieving data from a network or file.*/}}

What data does this integration collect?

{{/* Complete this section with information on what types of data the integration collects, and link to reference documentation if available */}} The EfficientIP DDI Logging integration collects log messages of the following types:

• ...

Supported use cases

{{/* Add details on the use cases that can be enabled by using this integration. Explain why a user would want to install and use this integration. */}}

What do I need to use this integration?

{{/* List any vendor-specific prerequisites needed before starting to install the integration. */}}

How do I deploy this integration?

Agent-based deployment

Elastic Agent must be installed. For more details, check the Elastic Agent installation instructions. You can install only one Elastic Agent per host.

Elastic Agent is required to stream data from the syslog or log file receiver and ship the data to Elastic, where the events will then be processed via the integration's ingest pipelines.

{{/* If agentless is available for this integration, we'll want to include that here as well.

Agentless deployment

Agentless deployments are only supported in Elastic Serverless and Elastic Cloud environments. Agentless deployments provide a means to ingest data while avoiding the orchestration, management, and maintenance needs associated with standard ingest infrastructure. Using an agentless deployment makes manual agent deployment unnecessary, allowing you to focus on your data instead of the agent that collects it.

For more information, refer to Agentless integrations and Agentless integrations FAQ */}}

Onboard / configure

{{/* List the steps that will need to be followed in order to completely set up a working integration. For integrations that support multiple input types, be sure to add steps for all inputs. */}}

Validation

{{/* How can the user test whether the integration is working? Including example commands or test files if applicable */}}

Troubleshooting

For help with Elastic ingest tools, check Common problems. {{/* Add any vendor specific troubleshooting here.

Are there common issues or “gotchas” for deploying this integration? If so, how can they be resolved? If applicable, links to the third-party software’s troubleshooting documentation. */}}

Scaling

For more information on architectures that can be used for scaling this integration, check the Ingest Architectures documentation. {{/* Add any vendor specific scaling information here */}}

Reference

{{/* Repeat for each data stream of the current type

{Data stream name}

The {data stream name} data stream provides events from {source} of the following types: {list types}.

For each data_stream_name, include an optional summary of the datastream, the exported fields reference table and the sample event.

The fields template function will be replaced by a generated list of all fields from the fields/ directory of the data stream when building the integration.

{data stream name} fields

To include a generated list of fields from the fields/ directory, uncomment and use: {{ fields "data_stream_name" }}

The event template function will be replace by a sample event, taken from sample_event.json, when building this integration.

To include a sample event from sample_event.json, uncomment and use: {{ event "data_stream_name" }}

*/}}

Inputs used

{{/* All inputs used by this package will be automatically listed here. */}} {{ inputDocs }}

API usage

{{/* For integrations that use APIs to collect data, document all the APIs that are used, and link to relevent information */}} These APIs are used with this integration:

• ...