Configurations
In NXLog Platform, a configuration refers to a predefined NXLog Agent configuration. See Create a configuration for instructions on how to create one.
You can create configurations for different requirements and apply them to multiple NXLog Agent instances in one go. Configurations dramatically improve the efficiency and scalability of managing your agents.
You can see your configurations on the Agents > Configurations page.
Configuration builder
When you click the Add configuration button on the Configurations page, NXLog Platform takes you to the configuration builder. Here, you can visualize your agent configuration’s data flow and save it. Use the interactive configuration builder to create your configuration, or click View configuration as text to switch to the configuration text editor.
| Setting | Description |
|---|---|
Name |
A free text field. Enter a name for your configuration here. |
Comment |
A free text field. Add an optional description for your configuration here. |
Route # |
The name of the route. Edit the route’s name by clicking on the adjacent pencil icon. Routes are numbered by default. In the configuration builder, you always add configuration components within the context of a route. |
Extensions |
Use this option to configure any extension module included in your configuration. Extension modules are automatically added to the configuration if they are required by another module or a process. |
Agent communication settings |
Use this option to configure the NXLog Agent remote management settings. |
View configuration as text |
Use this switch to toggle between the interactive and the text-based view. |
Collect from |
A list of data sources. Drag and drop a data source from one of the Collect snippet lists to an empty Collect from module slot to configure the data source. |
Send to |
A list of destinations. Drag and drop a destination from one of the Forward snippet lists to an empty Send to module slot to configure the destination. |
+ Add another route |
Click this button to add another route with different configuration components. |
Configuration snippets
The configuration builder provides snippets for creating a configuration. Snippets can either be pre-built configuration templates for specific use cases, or smaller NXLog Agent configuration components for building a configuration from scratch.
Access to configuration snippets depends on your NXLog Platform subscription plan. If you don’t have the Premium plan, use Show only available to view the snippets included in your current plan.
| Name | Description |
|---|---|
Templates |
A list of templates. Drag and drop a template to the Configuration details panel to add it to the configuration. |
Collect events |
A list of event data sources. Drag and drop an event data source to a module slot to add it to the configuration. |
Collect metrics |
A list of metrics data sources. Drag and drop a metrics data source to a module slot to add it to the configuration. |
Actions |
A list of actions that you can execute on log events. Drag and drop an action to a process slot to add it to the configuration. For more information, see the Configuration actions page. |
Forward events |
A list of destinations for event data. Drag and drop an event data destination to a module slot to add it to the configuration. |
Forward metrics |
A list of destinations for metrics data. Drag and drop a metrics data destination to a module slot to add it to the configuration. |