# NXLog Documentation > NXLog Platform is NXLog's telemetry data management suite for collecting, > processing, storing, and analyzing logs, metrics, and traces at enterprise > scale. This documentation covers installation, configuration, agent > management, telemetry data collection, storage, analytics, and integrations > with third-party systems and SIEMs. NXLog Platform comprises three products: - NXLog Agent, the collection engine, runs on Windows, Linux, and macOS and natively supports OpenTelemetry (OTLP), collecting and forwarding logs, metrics, and traces to any destination. - NXLog Pipeline Manager manages agents centrally through its web UI or the Agent Management API. - NXLog Storage stores telemetry data for search and analytics. Every page below links to its Markdown version. Replace `.md` with `.html` in a link to open the page on the documentation site. Each Markdown file starts with YAML front matter that gives the page's title, description, source URL, and position in the navigation. ## NXLog Platform User Guide ### Getting started - [Getting started](https://docs.nxlog.co/platform/current/getting-started.md): Learn how to use NXLog Platform and set up your own instance. - [Quick start guide](https://docs.nxlog.co/platform/current/quick-start-guide.md): Welcome to the NXLog Platform on-premises quick start guide, intended to help you quickly set up an NXLog Platform instance for testing. - [What is NXLog Platform?](https://docs.nxlog.co/platform/current/platform-overview.md): NXLog Platform is a unified telemetry data collection, log storage, and agent management solution, giving you all the tools you need to configure and monitor your telemetry pipeline. - [Sign up for NXLog Platform](https://docs.nxlog.co/platform/current/sign-up.md): You can sign up for NXLog Platform using one of the following methods: - [Navigating the NXLog Platform UI](https://docs.nxlog.co/platform/current/nxlog-platform-ui.md): The NXLog Platform web interface is where you will manage your user account, organization, NXLog Agent fleet, and log storage. - [NXLog Platform terminology](https://docs.nxlog.co/platform/current/terminology.md): This glossary explains key concepts and definitions of the terminology you will come across in NXLog Platform. ### Platform administration - [Platform administration](https://docs.nxlog.co/platform/current/administration/index.md): NXLog Platform documentation on managing your instance, organization settings, and users. - [How-to](https://docs.nxlog.co/platform/current/administration/how-to/index.md) - [Configure a mail server](https://docs.nxlog.co/platform/current/administration/how-to/configure-a-mail-server.md): NXLog Platform needs to connect to an SMTP server to send emails such as user invites, password reset requests, and system alerts. - [Activate Single Sign-On (SSO)](https://docs.nxlog.co/platform/current/administration/how-to/activate-single-sign-on.md): NXLog Platform integrates with third-party authentication services to simplify your users' sign-up and login process, eliminating the need to manage another set of credentials. - [GitLab.com](https://docs.nxlog.co/platform/current/administration/how-to/activate-gitlab-authentication.md): To configure Single Sign-On (SSO) with GitLab.com, you must first create a GitLab application. - [Google](https://docs.nxlog.co/platform/current/administration/how-to/activate-google-authentication.md): To configure Single Sign-On (SSO) with Google, you must first create a Google Cloud project, configure the OAuth consent screen, and create an OAuth client. - [Microsoft](https://docs.nxlog.co/platform/current/administration/how-to/activate-microsoft-azure-authentication.md): To configure Single Sign-On (SSO) with Microsoft accounts, you must first create a Microsoft Entra ID application registration and client secret and configure API access permissions. - [Update organization details](https://docs.nxlog.co/platform/current/administration/how-to/update-organization-details.md): To view your organization’s information, sign in to NXLog Platform and navigate to **Organization overview** > **Organization details**. - [Manage organization users](https://docs.nxlog.co/platform/current/administration/how-to/manage-organization-users.md): To manage your organization’s users, sign in to NXLog Platform and navigate to **Settings** > **Users** and switch to the **Users** view. - [Manage your user account](https://docs.nxlog.co/platform/current/administration/how-to/manage-your-account.md): Keeping your user account settings up-to-date ensures NXLog can identify and contact you when needed. - [Recover an account protected with 2FA](https://docs.nxlog.co/platform/current/administration/how-to/recover-account-protected-with-2fa.md): If a user loses their device or their authenticator app is not working, they need to use the recovery codes provided when they activated two-factor authentication or ask an administrator to reset two-factor authentication for their account. - View NXLog Platform logs - [Search logs](https://docs.nxlog.co/platform/current/administration/how-to/search-logs.md): You can search NXLog Platform audit and system logs by following these steps: - [Create a filter](https://docs.nxlog.co/platform/current/administration/how-to/create-a-filter.md): Filters add an extra layer of functionality to log searches, allowing you to drill down search results further by specifying additional parameters. - [View log details](https://docs.nxlog.co/platform/current/administration/how-to/view-log-details.md): Log discovery displays log records in a table containing standard information across data sources. - [View logs timeline](https://docs.nxlog.co/platform/current/administration/how-to/view-logs-timeline.md): A log search can return data for a large timeframe. - [Export logs](https://docs.nxlog.co/platform/current/administration/how-to/export-logs.md): While NXLog Platform provides tools to analyze logs, you may need to export audit or system logs for reporting or processing in other tools or offline archiving. - [Explanation](https://docs.nxlog.co/platform/current/administration/explanation/index.md) - [Audit logs](https://docs.nxlog.co/platform/current/administration/explanation/audit-logs.md): The audit log records NXLog Platform user activity related to data storage and management. - [System logs](https://docs.nxlog.co/platform/current/administration/explanation/system-logs.md): System logs give you insights into system behavior and a real-time record of activities, so you can monitor your NXLog Platform instance and detect operational errors. - [System settings](https://docs.nxlog.co/platform/current/administration/explanation/system-settings.md): You can configure general NXLog Platform settings from the **System** page, including Single Sign-on (SSO), mail server, and security settings. - [Users and roles](https://docs.nxlog.co/platform/current/administration/explanation/users-and-roles.md): NXLog Platform supports Role-Based Access Control (RBAC) to define what each user can access with fine-grained access permissions. - [User account management](https://docs.nxlog.co/platform/current/administration/explanation/user-account-management.md): The **Account** page gives you convenient access to your user account settings. - [Organization management](https://docs.nxlog.co/platform/current/administration/explanation/organization-management.md): To view and update your organization settings, click **Organization overview** from the left navigation menu. - [Entitlements usage](https://docs.nxlog.co/platform/current/administration/explanation/entitlements-usage.md): How NXLog Platform calculates and displays your data source entitlements usage. - [Data source counting](https://docs.nxlog.co/platform/current/administration/explanation/data-source-counting.md): How NXLog Platform counts data sources for licensing purposes, and how to ensure accurate counting in agentless deployments. - [Reference](https://docs.nxlog.co/platform/current/administration/reference/index.md) - [Roles and permissions](https://docs.nxlog.co/platform/current/administration/reference/roles-and-permissions.md): NXLog Platform includes a wide range of system operations and access to information that can be considered sensitive. - [Log filters](https://docs.nxlog.co/platform/current/administration/reference/filters.md): NXLog Platform includes log filtering capabilities that allow you to perform audit and system log analysis. ### Agent management - [Agent management](https://docs.nxlog.co/platform/current/agent-management/index.md): Landing page for NXLog Platform agent management, highlighting how to enroll agents, create configurations, and check agent status and deployment state. - [How-to](https://docs.nxlog.co/platform/current/agent-management/how-to/index.md): Browse NXLog Platform how-to guides for agent management and agent configuration tasks, from enrollment to certificates and templates. - [Enroll an agent](https://docs.nxlog.co/platform/current/agent-management/how-to/enroll-an-agent.md): Compares the manual and automatic methods for enrolling NXLog Agent instances in NXLog Platform, based on deployment scale and agent identification. - [Enroll an agent manually](https://docs.nxlog.co/platform/current/agent-management/how-to/enroll-an-agent-manually.md): How to manually install, enroll, and unenroll a single NXLog Agent instance in NXLog Platform using the agent enrollment wizard. - [Set up automatic agent enrollment](https://docs.nxlog.co/platform/current/agent-management/how-to/set-up-auto-enroll.md): How to create NXLog Platform auto-enroll rules using agent properties such as the hostname or IP address, or regular expressions to match agents. - [Bulk-deploy NXLog Agent](https://docs.nxlog.co/platform/current/agent-management/how-to/bulk-deploy-nxlog-agent.md): How to configure NXLog Agent to automatically enroll to NXLog Platform on installation using agent labels, or deploy at scale with SCM tools. - [Deploy NXLog Agent with Microsoft GPO](https://docs.nxlog.co/platform/current/agent-management/how-to/deploy-nxlog-with-microsoft-gpo.md): How to deploy NXLog Agent to Windows machines using Microsoft Group Policy Objects, an MSI transform file, and Active Directory groups. - [Deploy NXLog Agent with Ansible](https://docs.nxlog.co/platform/current/agent-management/how-to/deploy-nxlog-with-ansible.md): How to deploy and uninstall NXLog Agent on Linux and Windows at scale using Ansible playbooks, inventory files, and WinRM for Windows nodes. - [Deploy NXLog Agent with Puppet Bolt](https://docs.nxlog.co/platform/current/agent-management/how-to/deploy-nxlog-with-puppet-bolt.md): How to deploy and uninstall NXLog Agent on Linux and Windows at scale using Puppet Bolt plans, an inventory file, and SSH or WinRM. - [Deploy NXLog Agent with Chef](https://docs.nxlog.co/platform/current/agent-management/how-to/deploy-nxlog-with-chef.md): How to deploy and uninstall NXLog Agent on Windows and Debian-based Linux using a Chef cookbook, recipes, and the knife command-line tool. - [Deploy NXLog Agent with Salt](https://docs.nxlog.co/platform/current/agent-management/how-to/deploy-nxlog-with-salt.md): How to deploy and uninstall NXLog Agent on Windows and Debian-based Linux using Salt state files, the Salt master, and minions. - [Assign a configuration](https://docs.nxlog.co/platform/current/agent-management/how-to/assign-a-configuration.md): How to assign a configuration to one or more agents, deploy configuration changes, and confirm that the configuration was applied. - [Create a configuration](https://docs.nxlog.co/platform/current/agent-management/how-to/create-a-configuration.md): How to create an NXLog Agent configuration in NXLog Platform using the drag-and-drop builder or the text editor, from data source to destination. - [Use a configuration template](https://docs.nxlog.co/platform/current/agent-management/how-to/use-a-template.md): How to apply a pre-defined NXLog Agent configuration template to your telemetry data pipeline using the configuration template wizard. - [Configure an individual agent](https://docs.nxlog.co/platform/current/agent-management/how-to/configure-an-individual-agent.md): How to update the configuration of a single NXLog Agent instance from NXLog Platform, using either the agents table or the agent details page. - [View an agent’s logs](https://docs.nxlog.co/platform/current/agent-management/how-to/view-an-agents-logs.md): How to view NXLog Agent log within NXLog Platform or on the host machine where the agent is installed for troubleshooting. - [Download agent information](https://docs.nxlog.co/platform/current/agent-management/how-to/download-agent-information.md): How to export the NXLog Platform agents table to a CSV file, including which columns are included and how to calculate the ratio field. - [Customize the Agents view](https://docs.nxlog.co/platform/current/agent-management/how-to/customize-the-agents-view.md): How to customize the NXLog Platform Agents view by filtering agents, configuring display names globally or per agent, and choosing table columns. - [Manage certificates](https://docs.nxlog.co/platform/current/agent-management/how-to/manage-certificates.md): How to manage the certificates that NXLog Agent instances use to communicate securely. - [Create a data flow visualization](https://docs.nxlog.co/platform/current/agent-management/how-to/create-a-data-flow-visualization.md): How to build an NXLog Platform log flow visualization dashboard showing your telemetry data pipeline architecture and EPS or MBps throughput. - [Explanation](https://docs.nxlog.co/platform/current/agent-management/explanation/index.md): Browse conceptual explanations of NXLog Platform agent management, covering agent status, deployment states, connectivity, and configuration. - [Certificates](https://docs.nxlog.co/platform/current/agent-management/explanation/certificates.md): Explains the NXLog Platform Certificates view, covering certificate authorities, the certificates table, and certificate details. - [Configurations](https://docs.nxlog.co/platform/current/agent-management/explanation/configurations-overview.md): Explains the NXLog Platform Configurations view, covering the configurations table columns, actions menu, and version history comparison. - [Configuration builder](https://docs.nxlog.co/platform/current/agent-management/explanation/configuration-builder.md): Explains the NXLog Platform configuration builder, covering routes, extensions, configuration snippets, and configuration actions such as parsing. - [Configuration templates](https://docs.nxlog.co/platform/current/agent-management/explanation/templates.md): Explains NXLog Platform configuration templates, which provide predefined configurations for common telemetry data sources and destinations, such as SIEMs. - [Agents](https://docs.nxlog.co/platform/current/agent-management/explanation/agents-view.md): Explains the NXLog Platform Agents view, covering the agents table, available agent actions, and the individual agent details page. - [Agent connectivity](https://docs.nxlog.co/platform/current/agent-management/explanation/agent-connectivity.md): Explains how NXLog Agent establishes secure, certificate-based connectivity with NXLog Platform through settings in the managed.conf configuration file. - [Agent status](https://docs.nxlog.co/platform/current/agent-management/explanation/agent-status.md): Explains the agent's connectivity status in NXLog Platform: New, Online, Offline, Error, and Warning. - [Agent deployment state](https://docs.nxlog.co/platform/current/agent-management/explanation/agent-deployment-state.md): Explains the NXLog Platform agent deployment states New, Enrolled, and Configured, their transitions, and the actions available in each state. - [Auto-enroll](https://docs.nxlog.co/platform/current/agent-management/explanation/auto-enroll.md): Explains how auto-enroll rules let NXLog Platform automatically enroll NXLog Agent instances when they first connect. - [Notifications](https://docs.nxlog.co/platform/current/agent-management/explanation/notifications.md): Explains the NXLog Platform Notifications page, which lists agent management informational and error messages for troubleshooting. - [API](https://docs.nxlog.co/platform/current/agent-management/explanation/api.md): Introduces the NXLog Platform Agent Management API for programmatically configuring, managing, and monitoring your NXLog Agent fleet. - [Reference](https://docs.nxlog.co/platform/current/agent-management/reference/index.md): Reference documentation for NXLog Platform agent management, covering agent and configuration properties, selector operators, and configuration templates. - [Agent properties](https://docs.nxlog.co/platform/current/agent-management/reference/agent-properties.md): Reference list of NXLog Agent properties, such as status, deployment state, and hostname, for building selector expressions to search agents in NXLog Platform. - [Configuration properties](https://docs.nxlog.co/platform/current/agent-management/reference/configuration-properties.md): Reference list of NXLog Platform configuration properties for building selector expressions to search and filter configurations. - [Selector operators](https://docs.nxlog.co/platform/current/agent-management/reference/selector-operators.md): Reference list of comparison and logical operators for writing selector expressions to query NXLog Agent instances or configurations. - [Default configurations](https://docs.nxlog.co/platform/current/agent-management/reference/default-configurations.md): Reference list of the default NXLog Platform configurations, including their input and output modules for telemetry data collection and forwarding. - [List of configuration templates](https://docs.nxlog.co/platform/current/agent-management/reference/templates.md): Reference list of NXLog Platform configuration templates, mapping supported SIEMs and data sources such as Splunk, Google SecOps, and Azure Sentinel. ### Telemetry collection - [Telemetry collection](https://docs.nxlog.co/platform/current/log-collection/index.md): NXLog Platform documentation on collecting, processing, and forwarding telemetry data. - [Tutorials](https://docs.nxlog.co/platform/current/log-collection/tutorials/index.md): Browse NXLog Agent tutorials for building your first configuration and transferring data securely using TLS between agent instances. - [Create your first NXLog Agent configuration](https://docs.nxlog.co/platform/current/log-collection/tutorials/create-your-first-configuration.md): Learn about the NXLog Agent configuration components by building a simple configuration. - [Create your first configuration with the configuration builder](https://docs.nxlog.co/platform/current/log-collection/tutorials/create-your-first-configuration-with-the-builder.md): Tutorial on creating your first NXLog Agent configuration using the NXLog Platform configuration builder, from data source to agent assignment. - [Create your first configuration with a configuration file](https://docs.nxlog.co/platform/current/log-collection/tutorials/create-your-first-configuration-using-a-configuration-file.md): Tutorial on creating your first NXLog Agent configuration file, covering constants, global directives, extensions, inputs, outputs, and routes. - [Transfer data over the network with TLS/SSL](https://docs.nxlog.co/platform/current/log-collection/tutorials/transfer-data-with-tls.md): Several NXLog Agent modules support TLS/SSL. To configure TLS/SSL, you will need a CA certificate, the server certificate, and its private key. - [How-to](https://docs.nxlog.co/platform/current/log-collection/how-to/index.md): Browse NXLog Agent how-to guides covering data collection, parsing, forwarding, processing, agent configuration, and troubleshooting. - Collect and parse data - [Parse unstructured events](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-unstructured-events.md): How to parse unstructured events with NXLog Agent. - [Parse common event formats](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-common-event-formats.md): How to parse structured events with NXLog Agent, including Common Log Format, syslog, and W3C. - [Common and Combined Log Format](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-common-and-combined-log-format.md): How to parse web server access logs in Common and Combined Log Format with NXLog Agent. - [Syslog](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-syslog.md): How to collect and parse syslog messages with NXLog Agent. - [W3C Extended Log File Format](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-w3c-extended-log-format.md): How to parse the W3C Extended Log File Format with NXLog Agent. - Parse standard data formats - [CSV](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-csv.md): How to collect and parse CSV-formatted data with NXLog Agent. - [JSON](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-json.md): How to collect and parse data in JSON format with NXLog Agent. - [XML](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-xml.md): How to process data with the NXLog Agent XML parser. - [Collect multiline events](https://docs.nxlog.co/platform/current/log-collection/how-to/collect-multiline-events.md): Collect and process multiline events and traces with NXLog Agent. - [Collect host metrics](https://docs.nxlog.co/platform/current/log-collection/how-to/collect-host-metrics.md): How to configure NXLog Agent to collect host metrics, including internal agent metrics, Windows performance counters, and Osquery data. - [Detect an inactive data source](https://docs.nxlog.co/platform/current/log-collection/how-to/detect-an-inactive-data-source.md): How to generate alerts when a data source stops generating telemetry data. - Process data - Process events - [Filter events](https://docs.nxlog.co/platform/current/log-collection/how-to/filter-events.md): How to filter out unnecessary or duplicate events to lower bandwidth requirements during transport, storage requirements for log data storage, and licensing costs for commercial SIEM systems. - [Trim events](https://docs.nxlog.co/platform/current/log-collection/how-to/trim-events.md): How to remove unnecessary content or fields from events to lower bandwidth requirements during transport, telemetry data storage requirements, and licensing costs for commercial SIEM systems. - [Normalize events](https://docs.nxlog.co/platform/current/log-collection/how-to/normalize-events.md): Transforming events to a common schema with NXLog Agent. - [Classify events](https://docs.nxlog.co/platform/current/log-collection/how-to/classify-events.md): Classify log records with a standard taxonomy with NXLog Agent. - [Correlate events](https://docs.nxlog.co/platform/current/log-collection/how-to/correlate-events.md): Automate event analysis and trigger custom actions with NXLog Agent's dedicated event correlation module. - Process metrics - [Filter metrics](https://docs.nxlog.co/platform/current/log-collection/how-to/filter-metrics.md): How to filter metrics with NXLog Agent by dropping non-production data and removing high-cardinality fields before forwarding. - [Scale and aggregate metrics](https://docs.nxlog.co/platform/current/log-collection/how-to/scale-and-aggregate-metrics.md): How to scale metric units and aggregate high-frequency values with NXLog Agent using statistical counters before forwarding. - [Convert data formats](https://docs.nxlog.co/platform/current/log-collection/how-to/convert-data-formats.md): How to convert telemetry data from one format to another with NXLog Agent. - [Convert events to metrics](https://docs.nxlog.co/platform/current/log-collection/how-to/convert-events-to-metrics.md): How to convert log events into numerical metrics using statistical counters for monitoring and alerting. - [Convert metrics to events](https://docs.nxlog.co/platform/current/log-collection/how-to/convert-metrics-to-events.md): How to evaluate metric values with conditional logic and convert them into alert events for SIEM or notification systems. - [Convert character sets](https://docs.nxlog.co/platform/current/log-collection/how-to/convert-character-sets.md): How to convert data to a different character set with NXLog Agent. - [Compress and encrypt data](https://docs.nxlog.co/platform/current/log-collection/how-to/compress-and-encrypt-data.md): How to compress and encrypt telemetry data using NXLog Agent. - [Mask sensitive data](https://docs.nxlog.co/platform/current/log-collection/how-to/mask-data.md): How to mask sensitive data in events with NXLog Agent. - [Process timestamps](https://docs.nxlog.co/platform/current/log-collection/how-to/process-timestamps.md): Browse NXLog Agent how-to guides for processing timestamps, covering parsing, adjusting, formatting, and preserving datetime values. - [Parse timestamps](https://docs.nxlog.co/platform/current/log-collection/how-to/parse-timestamps.md): How to parse timestamps in NXLog Agent using parsedate and strptime functions, including fallback and custom date formats. - [Adjust timestamps](https://docs.nxlog.co/platform/current/log-collection/how-to/adjust-timestamps.md): How to adjust incorrect or incomplete timestamps in telemetry data by replacing, reversing offsets, or modifying event times. - [Format timestamps](https://docs.nxlog.co/platform/current/log-collection/how-to/format-timestamps.md): How to format datetime values as strings in NXLog Agent using default formatting or custom strftime patterns, including UTC output. - [Preserve timestamps across time zones](https://docs.nxlog.co/platform/current/log-collection/how-to/preserve-timestamps-across-timezones.md): How to normalize NXLog Agent timestamps to UTC when parsing and generating dates. - [Preserve timestamps between NXLog Agent instances](https://docs.nxlog.co/platform/current/log-collection/how-to/preserve-timestamps-between-nxlog-agent-instances.md): How to preserve timestamps between NXLog Agent instances using the Binary output and input format over TCP. - Forward data - [Forward events to common destinations](https://docs.nxlog.co/platform/current/log-collection/how-to/forward-events-to-common-destinations.md): How to configure NXLog Agent to forward events to local files, NXLog Platform, or TCP hosts. - [Expose Prometheus-compatible metrics](https://docs.nxlog.co/platform/current/log-collection/how-to/expose-prometheus-compatible-metrics.md): How to configure NXLog Agent to expose metrics as a Prometheus scrape endpoint using the om_prometheus output module. - [Send metrics to Graphite](https://docs.nxlog.co/platform/current/log-collection/how-to/send-metrics-to-graphite.md): How to configure NXLog Agent to send metrics to a Graphite server using the TCP output module. - [Configure an NXLog Agent relay](https://docs.nxlog.co/platform/current/log-collection/how-to/configure-agent-relay.md): Learn how to configure NXLog Agent as a relay to collect data from agentless sources, forward data between NXLog Agent instances, and set up a relay cluster with failover. - [Prioritize data forwarding](https://docs.nxlog.co/platform/current/log-collection/how-to/prioritize-data-forwarding.md): How to process telemetry data based on priority with NXLog Agent. - [Use dynamic output filenames](https://docs.nxlog.co/platform/current/log-collection/how-to/use-dynamic-filenames.md): How to write telemetry data to dynamic filenames with NXLog Agent. - Configure agent operation - [Configure TLS/SSL](https://docs.nxlog.co/platform/current/log-collection/how-to/configure-tls-ssl.md): NXLog Agent supports secure data transfer with TLS/SSL. You will need a CA certificate, the server certificate, and its private key. - [Configure buffering](https://docs.nxlog.co/platform/current/log-collection/how-to/configure-buffering.md): Configuring the buffering and flow control features available in NXLog Agent. - [Trigger alerts](https://docs.nxlog.co/platform/current/log-collection/how-to/trigger-alerts.md): How to generate alerts for high-priority events with NXLog Agent. - [Rotate and delete log files](https://docs.nxlog.co/platform/current/log-collection/how-to/rotate-and-delete-log-files.md): How to implement a log rotation and retention policy with NXLog Agent. - [Protect against data loss](https://docs.nxlog.co/platform/current/log-collection/how-to/protect-against-data-loss.md): You can configure NXLog Agent to use disk-based queues and cache files for reliability and data integrity. - [Protect against duplicate data](https://docs.nxlog.co/platform/current/log-collection/how-to/protect-against-duplicate-data.md): NXLog Agent's duplicate_guard() procedure detects and deletes duplicate records. - [Distribute data processing](https://docs.nxlog.co/platform/current/log-collection/how-to/distribute-nxlog-agent-load.md): How to implement distributed data processing with NXLog Agent. - [Configure load balancing](https://docs.nxlog.co/platform/current/log-collection/how-to/configure-load-balancing.md): Learn how to configure an NXLog Agent relay cluster with load balancing and automatic failover. - Control resource usage - [RAM and CPU](https://docs.nxlog.co/platform/current/log-collection/how-to/control-nxlog-agent-resource-usage.md): How to set up control measures to cap NXLog Agent RAM and CPU usage. - [Bandwidth](https://docs.nxlog.co/platform/current/log-collection/how-to/control-nxlog-agent-bandwidth-usage.md): Implementing rate limiting and traffic shaping strategies to control NXLog Agent's bandwidth usage. - [Automatically restart NXLog Agent](https://docs.nxlog.co/platform/current/log-collection/how-to/automatically-restart-nxlog-agent.md): Monitoring and recovery settings to restart NXLog Agent safely if it stops unexpectedly. - Troubleshoot data processing - [General troubleshooting tips](https://docs.nxlog.co/platform/current/log-collection/how-to/troubleshooting-tips.md): General troubleshooting tips for NXLog Agent data processing, including logging messages, writing to custom files, and inspecting fields. - [Common issues](https://docs.nxlog.co/platform/current/log-collection/how-to/troubleshoot-common-issues.md): Troubleshooting tips for common NXLog Agent issues, including data not being collected and output files containing empty lines. - [Explanation](https://docs.nxlog.co/platform/current/log-collection/explanation/index.md): Browse conceptual explanations covering NXLog Agent data collection, data processing, bandwidth, encryption, and high availability. - [Data collection modes](https://docs.nxlog.co/platform/current/log-collection/explanation/data-collection-modes.md): An explanation of the data collection methods available with NXLog Agent. - [Data processing overview](https://docs.nxlog.co/platform/current/log-collection/explanation/data-processing-overview.md): An introduction to telemetry data processing with NXLog Agent - [Records and fields](https://docs.nxlog.co/platform/current/log-collection/explanation/records-and-fields.md): An explanation of NXLog Agent's concept of records and fields. - [Modules and routes](https://docs.nxlog.co/platform/current/log-collection/explanation/modules-and-routes.md): Using NXLog Agent modules and routes to build a telemetry data collection, processing, and forwarding sequence. - [Buffering and flow control](https://docs.nxlog.co/platform/current/log-collection/explanation/buffering-and-flow-control.md): An explanation of the data buffering and flow control features of NXLog Agent. - [Batch processing](https://docs.nxlog.co/platform/current/log-collection/explanation/batch-processing.md): An explanation of the NXLog Agent batch processing mechanism. - [Centralized telemetry data collection](https://docs.nxlog.co/platform/current/log-collection/explanation/centralized-data-collection.md): An explanation of centralized telemetry data collection and using NXLog Agent as a relay. - [Timestamps](https://docs.nxlog.co/platform/current/log-collection/explanation/timestamps.md): Learn how NXLog Agent handles timestamps and convert custom timestamp formats with NXLog Agent. - [Compression and encryption](https://docs.nxlog.co/platform/current/log-collection/explanation/data-compression-and-encryption.md): How NXLog Agent data converters compress, decompress, encrypt, and decrypt files using the xm_zlib and xm_crypto extension modules. - [Bandwidth usage](https://docs.nxlog.co/platform/current/log-collection/explanation/bandwidth-usage.md): Reducing the bandwidth used by NXLog Agent to lower bandwidth requirements during transport, storage requirements, and licensing costs for commercial SIEM systems. - [TLS/SSL data transfer](https://docs.nxlog.co/platform/current/log-collection/explanation/tls-ssl-data-transfer.md): Introduction to the encrypted data transfer in NXLog Agent - [High availability](https://docs.nxlog.co/platform/current/log-collection/explanation/high-availability.md): NXLog Agent high availability (HA) ensures continuous telemetry data collection using failover clusters and load balancing to minimize downtime and optimize performance. ### Log storage - [Log storage](https://docs.nxlog.co/platform/current/log-storage/index.md): NXLog Platform documentation on managing your log database. - [How-to](https://docs.nxlog.co/platform/current/log-storage/how-to/index.md): Browse step-by-step how-to guides covering data access and data management tasks for the NXLog Platform log storage component and logs database. - [Create an access rule](https://docs.nxlog.co/platform/current/log-storage/how-to/create-access-rule.md): How to create an access rule that grants specific users permission to view selected log types in NXLog Platform. - [Set data retention](https://docs.nxlog.co/platform/current/log-storage/how-to/set-data-retention.md): How to configure global and custom data retention periods for log types stored in your NXLog Platform logs database. - [Purge data](https://docs.nxlog.co/platform/current/log-storage/how-to/purge-data.md): How to purge data globally or by log type from your NXLog Platform logs database when you no longer need it. - [Delete a log type](https://docs.nxlog.co/platform/current/log-storage/how-to/delete-a-log-type.md): How to delete a log type from NXLog Platform after purging all associated data, since types with data cannot be removed. - [Explanation](https://docs.nxlog.co/platform/current/log-storage/explanation/index.md): Browse conceptual explanations of data access, data management, and data format topics for the NXLog Platform log storage component. - [Log database status dashboard](https://docs.nxlog.co/platform/current/log-storage/explanation/log-database-status-dashboard.md): Learn how the log database status dashboard shows health indicators and per log type storage statistics for your NXLog Platform logs database. - [Log types management](https://docs.nxlog.co/platform/current/log-storage/explanation/log-types-management.md): Learn how the log types management view lets you configure data retention, log types, and access rules for your NXLog Platform logs database. - [Access rules](https://docs.nxlog.co/platform/current/log-storage/explanation/access-rules.md): Learn how access rules provide fine-grained, role-based control over which log types individual users can view in NXLog Platform. - [Date formats](https://docs.nxlog.co/platform/current/log-storage/explanation/date-formats.md): Understand the datetime and string date formats the NXLog Platform logs database accepts to ensure log records get accurate timestamps. ### Log analytics - [Log analytics](https://docs.nxlog.co/platform/current/log-analytics/index.md): NXLog Platform documentation on searching and visualizing your data. - [How-to](https://docs.nxlog.co/platform/current/log-analytics/how-to/index.md): Guides for searching your data and managing NXLog Platform dashboards, including creating, activating, and deleting custom dashboards. - [Search logs](https://docs.nxlog.co/platform/current/log-analytics/how-to/search-logs.md): How to perform log searches, using the query builder, analyzing results, exporting data, and saving searches in NXLog Platform. - [Create a dashboard](https://docs.nxlog.co/platform/current/log-analytics/how-to/create-a-dashboard.md): How to create a custom NXLog Platform dashboard, adding widgets, arranging the layout, and saving your configuration. - [Manage dashboards](https://docs.nxlog.co/platform/current/log-analytics/how-to/manage-dashboards.md): How to activate, deactivate, pin, unpin, reorder, and delete custom dashboards from the NXLog Platform dashboards page. - [Explanation](https://docs.nxlog.co/platform/current/log-analytics/explanation/index.md): Conceptual overview of NXLog Platform log search and dashboards, covering log discovery, the logs overview dashboard, and custom dashboards. - [Log search](https://docs.nxlog.co/platform/current/log-analytics/explanation/log-search.md): Introduces NXLog Platform log search, which includes the logs overview dashboard and the log discovery tool for searching and visualizing data. - [Logs overview](https://docs.nxlog.co/platform/current/log-analytics/explanation/logs-overview.md): Explains the widgets on the NXLog Platform logs overview dashboard, including log counts, log types, log sources, and ingestion timelines. - [Log discovery](https://docs.nxlog.co/platform/current/log-analytics/explanation/log-discovery.md): Describes the NXLog Platform log discovery page, covering the search toolbar, search conditions, data table, saved searches, and exporting results. - [Dashboards](https://docs.nxlog.co/platform/current/log-analytics/explanation/about-dashboards.md): The default and custom dashboards in NXLog Platform let you visualize data using predefined and configurable widgets and charts. - [Reference](https://docs.nxlog.co/platform/current/log-analytics/reference/index.md): Reference documentation for NXLog Platform log analytics, covering available dashboard widgets and the fields in the logs table. - [Logs table](https://docs.nxlog.co/platform/current/log-analytics/reference/logs-table.md): Reference for the NXLog Platform logs table, describing the core, common, and custom fields available when searching and filtering data. - [Dashboard widgets](https://docs.nxlog.co/platform/current/log-analytics/reference/dashboard-widgets.md): Reference list of NXLog Platform dashboard widgets, including pie charts, sunburst charts, timelines, top values, and treemaps. ### Support policy - [Support policy](https://docs.nxlog.co/platform/current/support-policy.md): NXLog maintains a regular release cycle. ### Other pages - [FAQs](https://docs.nxlog.co/platform/current/faqs.md): Our Getting started guide contains instructions for registering an NXLog Platform account and installing NXLog Platform on-premises. - [macOS ULS to OSLog Migration Guide](https://docs.nxlog.co/platform/current/macos-uls-to-oslog-migration.md): This guide helps you move macOS log collection from the macOS ULS input module to the new macOS OSLog input module. - [NXLog Manager to Platform Migration Guide](https://docs.nxlog.co/platform/current/nxlog-manager-to-platform-migration.md): We recommend contacting us to schedule a session with one of our engineers to walk you through the migration process. - [NXLog Platform User Guide](https://docs.nxlog.co/platform/current/index.md): Here, you can learn how to use NXLog Platform and NXLog Agent and how they interact. ## NXLog Platform Deployment Guide - [NXLog Platform Deployment Guide](https://docs.nxlog.co/deployment/current/index.md): Install NXLog Platform on-premises and manage operations such as upgrading, backing up, restoring, and uninstalling instances. ### Install NXLog Platform on-premises - [Install NXLog Platform on-premises](https://docs.nxlog.co/deployment/current/install/index.md): Learn how to install NXLog Platform on-premises on a Linux machine, including air-gapped environments, or in a Kubernetes cluster using Helm. - Install on Linux - [System requirements](https://docs.nxlog.co/deployment/current/install/system-requirements-on-linux.md): CPU, RAM, storage, and network requirements for deploying NXLog Platform on a Linux host machine. - [Install](https://docs.nxlog.co/deployment/current/install/install-platform-on-linux.md): Deploy and configure NXLog Platform on a physical or virtual Linux machine. - [Troubleshooting](https://docs.nxlog.co/deployment/current/install/troubleshooting-on-linux.md): Find solutions to common issues for NXLog Platform installations on a Linux host machine. - Install on Linux (air-gapped) - [System requirements](https://docs.nxlog.co/deployment/current/install/system-requirements-air-gapped.md): CPU, RAM, storage, and network requirements for deploying NXLog Platform in a Linux environment with no internet access. - [Install](https://docs.nxlog.co/deployment/current/install/install-platform-air-gapped.md): Deploy and configure NXLog Platform on a Linux host with no internet access. - [Troubleshooting](https://docs.nxlog.co/deployment/current/install/troubleshooting-air-gapped.md): Find solutions to common issues when installing NXLog Platform in an air-gapped environment, including missing image bundles and license import failures. - Install on Kubernetes - [System requirements](https://docs.nxlog.co/deployment/current/install/system-requirements-using-helm.md): Kubernetes cluster, CPU, RAM, storage, and network requirements for deploying NXLog Platform using the Helm chart. - [Install](https://docs.nxlog.co/deployment/current/install/install-platform-using-helm.md): Deploy and configure NXLog Platform on Kubernetes using the Helm chart, including registry authentication, ingress configuration, and command-line or YAML-based installation. ### Administer NXLog Platform - [Administer NXLog Platform](https://docs.nxlog.co/deployment/current/administration/index.md): NXLog Platform documentation on managing your on-premises deployment, including start/stop, upgrades, backup and restore, and the CLI. - [How-to](https://docs.nxlog.co/deployment/current/administration/how-to/index.md): Follow step-by-step instructions for common NXLog Platform administration tasks, including backups, upgrades, managing certificates, and troubleshooting. - [Start and stop NXLog Platform](https://docs.nxlog.co/deployment/current/administration/how-to/start-stop-nxlog-platform.md): Manually stop and start NXLog Platform using the nxp_manage.sh script. - [Upgrade NXLog Platform](https://docs.nxlog.co/deployment/current/administration/how-to/upgrade-nxlog-platform.md): Upgrade NXLog Platform to a new version using the Linux CLI installer, an air-gapped package, or the Helm chart on Kubernetes. - [Back up and restore NXLog Platform](https://docs.nxlog.co/deployment/current/administration/how-to/back-up-and-restore.md): Create full system backups and restore NXLog Platform to the same or a different machine while preserving agent connections. - [Uninstall NXLog Platform](https://docs.nxlog.co/deployment/current/administration/how-to/uninstall-nxlog-platform.md): Remove NXLog Platform and its data using the nxp_manage.sh prune command on Linux, or by uninstalling the Helm chart on Kubernetes. - [Import custom TLS certificates](https://docs.nxlog.co/deployment/current/administration/how-to/import-custom-tls-certificates.md): Replace the self-signed TLS certificate used by NXLog Platform with your own certificate, or import a custom CA to sign agent certificates. - [Change the NXLog Agent listening port](https://docs.nxlog.co/deployment/current/administration/how-to/change-the-agent-listening-port.md): Update the TCP port that NXLog Platform uses to listen for incoming NXLog Agent connections after installation. - [Export logs using the CLI](https://docs.nxlog.co/deployment/current/administration/how-to/export-logs-cli.md): Query the ClickHouse database directly to export NXLog Platform customer or audit logs to a CSV file for compliance and reporting workflows. - [Troubleshoot common issues](https://docs.nxlog.co/deployment/current/administration/how-to/troubleshoot-common-issues.md): Diagnose and resolve common NXLog Platform issues such as missing logs in Log search, ClickHouse connectivity errors, and JSON parsing anomalies. - [Explanation](https://docs.nxlog.co/deployment/current/administration/explanation/index.md): Explore conceptual background on NXLog Platform architecture and system backups to understand how an on-premises deployment works internally. - [NXLog Platform architecture](https://docs.nxlog.co/deployment/current/administration/explanation/nxlog-platform-architecture.md): An overview of the NXLog Platform architecture, covering the high-level component structure for Linux and Kubernetes deployments. - [Linux](https://docs.nxlog.co/deployment/current/administration/explanation/nxlog-platform-architecture-linux.md): An overview of the NXLog Platform architecture on Linux, including components, containers, and network configuration using Podman and Docker Compose. - [Kubernetes](https://docs.nxlog.co/deployment/current/administration/explanation/nxlog-platform-architecture-kubernetes.md): An overview of the NXLog Platform architecture on Kubernetes, including components, pods, and network configuration within a cluster. - [System and log database backups](https://docs.nxlog.co/deployment/current/administration/explanation/system-and-log-database-backups.md): Learn how backups capture the logs database and configuration into one archive, and why offsite copies matter for disaster recovery. - [Reference](https://docs.nxlog.co/deployment/current/administration/reference/index.md): Reference documentation on NXLog Platform backup file structure and the nxp_manage.sh CLI commands for on-premises administration. - [CLI commands for managing NXLog Platform](https://docs.nxlog.co/deployment/current/administration/reference/cli-commands.md): Find the complete list of nxp_manage.sh commands for installing, starting, upgrading, backing up, monitoring, and removing NXLog Platform on Linux. - [Backup location and structure](https://docs.nxlog.co/deployment/current/administration/reference/backup-structure.md): Information about the NXLog Platform backup archives, how filenames encode the version and timestamp, and what each backup subdirectory contains. ## NXLog Agent Reference Manual ### Installation - [Installation](https://docs.nxlog.co/agent/current/install/index.md): NXLog Agent system requirements and installation guides. - Prerequisites - [Supported platforms](https://docs.nxlog.co/agent/current/install/platforms.md): NXLog Agent supported platforms and operating systems. - [System requirements](https://docs.nxlog.co/agent/current/install/requirements.md): NXLog Agent system requirements. - [Digital signature](https://docs.nxlog.co/agent/current/install/signature-verification.md): How to verify the NXLog Agent installer package digital signature. - [Platform differences](https://docs.nxlog.co/agent/current/install/os-differences.md): NXLog Agent supported platforms and operating systems. - Module catalog - [Modules by type](https://docs.nxlog.co/agent/current/install/modules-by-type.md): NXLog Agent provides several input, output, processor, and extension modules. - [Modules by operating system](https://docs.nxlog.co/agent/current/install/modules-by-os.md): NXLog Agent provides several input, output, processor, and extension modules. - [Modules by installation package](https://docs.nxlog.co/agent/current/install/modules-by-package.md): NXLog Agent provides several input, output, processor, and extension modules. - Install guides - [Red Hat Enterprise Linux](https://docs.nxlog.co/agent/current/install/rhel.md): Installing NXLog Agent on Red Hat Enterprise Linux and related systems. - [Debian/Ubuntu](https://docs.nxlog.co/agent/current/install/debian.md): Installing NXLog Agent on Debian GNU/Linux and related systems. - [SUSE Linux Enterprise Server](https://docs.nxlog.co/agent/current/install/sles.md): Installing NXLog Agent on SUSE Linux Enterprise Server. - [FreeBSD](https://docs.nxlog.co/agent/current/install/freebsd.md): Installing NXLog Agent on FreeBSD. - [Microsoft Windows](https://docs.nxlog.co/agent/current/install/windows.md): Installing NXLog Agent on Microsoft Windows interactively or via Group Policy. - [Microsoft Nano Server](https://docs.nxlog.co/agent/current/install/nano.md): Installing NXLog Agent on Microsoft Nano Server. - [Apple macOS](https://docs.nxlog.co/agent/current/install/macos.md): Installing NXLog Agent on Apple macOS. - [IBM AIX](https://docs.nxlog.co/agent/current/install/aix.md): Installing NXLog Agent on IBM AIX. - [Oracle Linux](https://docs.nxlog.co/agent/current/install/oracle.md): Deploying NXLog Agent on Oracle Linux and related systems. - [Oracle Solaris](https://docs.nxlog.co/agent/current/install/solaris.md): Installing NXLog Agent on Oracle Solaris. - [Docker](https://docs.nxlog.co/agent/current/install/docker.md): Deploying NXLog Agent as a Docker container application. - [Hardening NXLog Agent](https://docs.nxlog.co/agent/current/install/hardening-agent.md): Linux and Windows offer different approaches to hardening NXLog Agent. - [Hardening on Linux](https://docs.nxlog.co/agent/current/install/hardening-agent-linux.md): Possible ways to harden NXLog Agent on Linux include controlling the privileges NXLog Agent runs with and creating and applying an SELinux policy. - [Hardening on Windows](https://docs.nxlog.co/agent/current/install/hardening-agent-windows.md): To harden NXLog Agent on Windows, you can run it under a dedicated service account with the minimum required privileges. - [Running NXLog Agent](https://docs.nxlog.co/agent/current/install/running-nxlog-agent.md): Command-line usage, file paths, and controls for NXLog Agent on Linux/UNIX and Windows. ### Configuration - [Configuration](https://docs.nxlog.co/agent/current/config/index.md): This documentation describes directives and blocks available for configuring NXLog Agent. - [Overview](https://docs.nxlog.co/agent/current/config/overview.md): NXLog Agent uses an Apache-style, file-based configuration system comprised of blocks and directives. - [General settings](https://docs.nxlog.co/agent/current/config/general-settings.md): You can use the following directives throughout the configuration file. - [Global settings](https://docs.nxlog.co/agent/current/config/global-settings.md): The following directives apply to the overall NXLog Agent operation. - [Common module settings](https://docs.nxlog.co/agent/current/config/common-settings.md): A module instance name may contain letters, digits, periods (`.`), and underscores (`_`). - [Route settings](https://docs.nxlog.co/agent/current/config/route-settings.md): A route name may contain letters, digits, periods (`.`), and underscores (`_`). ### Language - [Language](https://docs.nxlog.co/agent/current/language/index.md) - [Data types](https://docs.nxlog.co/agent/current/language/types.md): Types are classifications that define the nature and operations of data, such as integers or strings. - [Expressions](https://docs.nxlog.co/agent/current/language/expressions.md): Expressions in the NXLog language are fundamental building blocks used to define and manipulate data. - [Operators](https://docs.nxlog.co/agent/current/language/operators.md): The following unary operations are available. - [Functions](https://docs.nxlog.co/agent/current/language/functions.md): A _function_ is an expression which returns a value. - [Statements](https://docs.nxlog.co/agent/current/language/statements.md): The following elements can be used in statements. - [Variables](https://docs.nxlog.co/agent/current/language/variables.md): A module variable can only be accessed from the same module instance where it was created. - [Statistical counters](https://docs.nxlog.co/agent/current/language/statistical-counters.md): Statistical counters in the NXLog language are specialized types for aggregating and analyzing log data. - [Core fields](https://docs.nxlog.co/agent/current/language/core-fields.md): NXLog Agent adds the following fields to every record it collects. - [Core functions](https://docs.nxlog.co/agent/current/language/core-functions.md): The following functions are exported by _core_. - [Core procedures](https://docs.nxlog.co/agent/current/language/core-procedures.md): The following procedures are exported by _core_. ### Input Modules - [Input Modules](https://docs.nxlog.co/agent/current/im/index.md): NXLog Agent modules that collect logs from various sources and are used at the beginning of an NXLog Agent route. - [Process Accounting (im_acct)](https://docs.nxlog.co/agent/current/im/acct.md): Documentation for NXLog Agent's process accounting input module and how to collect process accounting logs. - [AIX Auditing (im_aixaudit)](https://docs.nxlog.co/agent/current/im/aixaudit.md): Documentation for NXLog Agent's AIX auditing input module and how to process AIX audit logs. - [Amazon S3 (im_amazons3)](https://docs.nxlog.co/agent/current/im/amazons3.md): Documentation for NXLog Agent's Amazon S3 input module and how to collect logs from Amazon S3 buckets. - [Microsoft Azure (im_azure)](https://docs.nxlog.co/agent/current/im/azure.md): Documentation for NXLog Agent's Microsoft Azure input module and how to collect logs from Microsoft Azure. - [Microsoft Azure Monitor (im_azuremonitor)](https://docs.nxlog.co/agent/current/im/azuremonitor.md): Documentation for NXLog Agent's Microsoft Azure Monitor intput module and how to collect logs from the Microsoft Azure Monitor Log Analytics API. - [NXLog Transport (im_batchcompress)](https://docs.nxlog.co/agent/current/im/batchcompress.md): Documentation for NXLog Agent's batched compression input module. It uses a custom protocol to receive log batches from another NXLog Agent instance. - [Basic Security Module Auditing (im_bsm)](https://docs.nxlog.co/agent/current/im/bsm.md): Documentation for NXLog Agent's Basic Security Module Auditing input module how to parse BSM Auditing API events. - [Check Point OPSEC LEA (im_checkpoint)](https://docs.nxlog.co/agent/current/im/checkpoint.md): Documentation for NXLog Agent's Check Point input module and how to collect Check Point logs over the OPSEC LEA protocol. - [DBI (im_dbi)](https://docs.nxlog.co/agent/current/im/dbi.md): Documentation for NXLog Agent's database input module. This module uses the libdbi library. - [Event Log for Windows (im_msvistalog)](https://docs.nxlog.co/agent/current/im/msvistalog.md): Documentation for NXLog Agent's Windows Event Log input module and how to collect events from Windows 2008, Vista, and later. - [Event Log for Windows XP/2000/2003 (im_mseventlog)](https://docs.nxlog.co/agent/current/im/mseventlog.md): Documentation for NXLog Agent's Windows Event Log input module and how to collect events from Windows XP, 2000, and 2003. - [Event Tracing for Windows (im_etw)](https://docs.nxlog.co/agent/current/im/etw.md): Documentation for NXLog Agent's Event Tracing for Windows input module and how to collect ETW events. - [External programs (im_exec)](https://docs.nxlog.co/agent/current/im/exec.md): Documentation for NXLog Agent's external application input module. - [File (im_file)](https://docs.nxlog.co/agent/current/im/file.md): Documentation for NXLog Agent's file input module and how to collect logs from a file. - [File Integrity Monitoring (im_fim)](https://docs.nxlog.co/agent/current/im/fim.md): Documentation for NXLog Agent's file integrity monitoring input module. - [Go (im_go)](https://docs.nxlog.co/agent/current/im/go.md): Documentation for NXLog Agent's Go input module and how to process logs with Go methods. - [Google Cloud Logging (im_googlelogging)](https://docs.nxlog.co/agent/current/im/googlelogging.md): Documentation for NXLog Agent's Google Cloud Logging input module and how to collect logs from Google Cloud Logging. - [Google Cloud Pub/Sub (im_googlepubsub)](https://docs.nxlog.co/agent/current/im/googlepubsub.md): Documentation for NXLog Agent's Google Cloud Pub/Sub input module and how to collect logs from Google Cloud Pub/Sub. - [HTTP(s) (im_http)](https://docs.nxlog.co/agent/current/im/http.md): Documentation for NXLog Agent's HTTP(s) input module and how to receive logs via HTTP or HTTPS. - [Internal (im_internal)](https://docs.nxlog.co/agent/current/im/internal.md): Documentation for NXLog Agent's internal logs input module. - [Internal Metrics (im_internalmetrics)](https://docs.nxlog.co/agent/current/im/internalmetrics.md): Documentation for NXLog Agent's internal metrics input module. - [Java (im_java)](https://docs.nxlog.co/agent/current/im/java.md): Documentation for NXLog Agent's Java input module and how to process logs with Java methods. - [Kafka (im_kafka)](https://docs.nxlog.co/agent/current/im/kafka.md): Documentation for NXLog Agent's Kafka input module and how to collect log events from an Apache Kafka topic. - [Kernel (im_kernel)](https://docs.nxlog.co/agent/current/im/kernel.md): Documentation for NXLog Agent's kernel input module and how to collect kernel log messages on Linux, BSD, and macOS. - [Linux Audit System (im_linuxaudit)](https://docs.nxlog.co/agent/current/im/linuxaudit.md): Documentation for NXLog Agent's Linux Audit System input module and how to collect Linux Audit logs. - [macOS Endpoint Security (im_maces)](https://docs.nxlog.co/agent/current/im/maces.md): Documentation for NXLog Agent's macOS Endpoint Security input module and how to collect Apple Endpoint Security logs from macOS 10.15 and later. - [macOS ULS (im_maculs)](https://docs.nxlog.co/agent/current/im/maculs.md): Documentation for NXLog Agent's macOS Unified Logging System input module and how to collect macOS logs from macOS 10.12 and later. - [macOS OSLog (im_macoslog)](https://docs.nxlog.co/agent/current/im/macoslog.md): Documentation for NXLog Agent's macOS OSLog input module and how to collect macOS logs from macOS 10.15 and later. - [Mark (im_mark)](https://docs.nxlog.co/agent/current/im/mark.md): Documentation for NXLog Agent's mark input module and how to ensure that NXLog Agent is running when log sources are not sending logs. - [Microsoft 365 (im_ms365)](https://docs.nxlog.co/agent/current/im/ms365.md): Documentation for NXLog Agent's Microsoft 365 input module and how to collect Microsoft 365 logs. - [Null (im_null)](https://docs.nxlog.co/agent/current/im/null.md): Documentation for NXLog Agent's dummy input module. This module can be used for testing, custom log processing, or scheduled execution. - [ODBC (im_odbc)](https://docs.nxlog.co/agent/current/im/odbc.md): Documentation for NXLog Agent's database input module. This module uses an ODBC driver. - [Okta (im_okta)](https://docs.nxlog.co/agent/current/im/okta.md): Documentation for NXLog Agent's Okta input module and how to collect logs from the Okta System Log API. - [Osquery (im_osquery)](https://docs.nxlog.co/agent/current/im/osquery.md): Documentation for NXLog Agent's Osquery input module and how to collect logs from Osquery. - [OpenTelemetry Collector (im_otel)](https://docs.nxlog.co/agent/current/im/otel.md): Documentation for NXLog Agent's OpenTelemetry input module. - [Packet capture (im_pcap)](https://docs.nxlog.co/agent/current/im/pcap.md): Documentation for NXLog Agent's network packet capture module and how to passively monitor network traffic. - [Perl (im_perl)](https://docs.nxlog.co/agent/current/im/perl.md): Documentation for NXLog Agent's Perl input module and how to process logs with Perl subroutines. - [Named Pipes (im_pipe)](https://docs.nxlog.co/agent/current/im/pipe.md): Documentation for NXLog Agent's named pipes input module and how to read logs from named pipes on UNIX-like operating systems. - [Python (im_python)](https://docs.nxlog.co/agent/current/im/python.md): Documentation for NXLog Agent's Python input module and how to process logs with Python functions. - [Redis (im_redis)](https://docs.nxlog.co/agent/current/im/redis.md): Documentation for NXLog Agent's Redis input module and how to collect logs from a Redis server. - [Windows Registry Monitoring (im_regmon)](https://docs.nxlog.co/agent/current/im/regmon.md): Documentation for NXLog Agent's Windows registry input module and how to generate events for registry changes. - [Ruby (im_ruby)](https://docs.nxlog.co/agent/current/im/ruby.md): Documentation for NXLog Agent's Ruby input module and how to process logs with Ruby methods. - [Salesforce (im_salesforce)](https://docs.nxlog.co/agent/current/im/salesforce.md): Documentation for NXLog Agent's Salesforce input module and how to collect Salesforce event monitoring log data. - [TLS/SSL (im_ssl)](https://docs.nxlog.co/agent/current/im/ssl.md): Documentation for NXLog Agent's TLS/SSL input module and how to receive logs over a secure connection. - [Systemd (im_systemd)](https://docs.nxlog.co/agent/current/im/systemd.md): Documentation for NXLog Agent's systemd input module and how to collect logs from the Linux systemd journal. - [TCP (im_tcp)](https://docs.nxlog.co/agent/current/im/tcp.md): Documentation for NXLog Agent's TCP input module and how to receive logs over a TCP connection. - [Test Generator (im_testgen)](https://docs.nxlog.co/agent/current/im/testgen.md): Documentation for NXLog Agent's test input module and how to generate events for testing. - [UDP (im_udp)](https://docs.nxlog.co/agent/current/im/udp.md): Documentation for NXLog Agent's UDP input module and how to receive logs as UDP datagrams. - [Unix Domain Sockets (im_uds)](https://docs.nxlog.co/agent/current/im/uds.md): Documentation for NXLog Agent's Unix Domain Sockets input module and how to receive logs over a Unix domain socket. - [Windows Performance Counters (im_winperfcount)](https://docs.nxlog.co/agent/current/im/winperfcount.md): Documentation for the Windows Performance Counters input module. - [Windows Event Collector (im_wseventing)](https://docs.nxlog.co/agent/current/im/wseventing.md): Documentation for NXLog Agent's Windows Event Forwarding input module and how to collect Windows events remotely. - [ZeroMQ (im_zmq)](https://docs.nxlog.co/agent/current/im/zmq.md): Documentation for NXLog Agent's ZeroMQ input module and how to receive logs with ZeroMQ. ### Output Modules - [Output Modules](https://docs.nxlog.co/agent/current/om/index.md): NXLog Agent modules that write or forward logs to their destination and are used at the end of an NXLog Agent route. - [Amazon S3 (om_amazons3)](https://docs.nxlog.co/agent/current/om/amazons3.md): Documentation for NXLog Agent's Amazon S3 output module and sending logs to Amazon S3 buckets. - [Microsoft Azure Sentinel (om_azure)](https://docs.nxlog.co/agent/current/om/azure.md): Documentation for NXLog Agent's Microsoft Azure output module and how to forward logs to Azure services. - [Microsoft Azure Logs Ingestion (om_azuremonitor)](https://docs.nxlog.co/agent/current/om/azuremonitor.md): Documentation for NXLog Agent's Microsoft Azure Logs Ingestion output module and how to forward logs to the Azure Monitor Logs Ingestion API. - [NXLog Transport (om_batchcompress)](https://docs.nxlog.co/agent/current/om/batchcompress.md): Documentation for NXLog Agent's batched compression output module. It uses a custom protocol to send log batches to another NXLog Agent instance. - [Blocker (om_blocker)](https://docs.nxlog.co/agent/current/om/blocker.md): Documentation for NXLog Agent's blocked route simulator. - [DBI (om_dbi)](https://docs.nxlog.co/agent/current/om/dbi.md): Documentation for NXLog Agent's database output module. This module uses the libdbi library. - [Elasticsearch (om_elasticsearch)](https://docs.nxlog.co/agent/current/om/elasticsearch.md): Documentation for NXLog Agent's Elasticsearch output module and how to send logs to an Elasticsearch server. - [Program (om_exec)](https://docs.nxlog.co/agent/current/om/exec.md): Documentation for NXLog Agent's external application output module. - [File (om_file)](https://docs.nxlog.co/agent/current/om/file.md): Documentation for NXLog Agent's file output module and how to write records to a file. - [Go (om_go)](https://docs.nxlog.co/agent/current/om/go.md): Documentation for NXLog Agent's Go output module and how to process logs with Go methods. - [Google Cloud Logging (om_googlelogging)](https://docs.nxlog.co/agent/current/om/googlelogging.md): Documentation for NXLog Agent's Google Cloud Logging output module and how to send logs to Google Cloud Logging. - [Google Cloud Pub/Sub (om_googlepubsub)](https://docs.nxlog.co/agent/current/om/googlepubsub.md): Documentation for NXLog Agent's Google Cloud Pub/Sub output module and how to publish logs to Google Cloud Pub/Sub. - [Google SecOps (om_chronicle)](https://docs.nxlog.co/agent/current/om/chronicle.md): Documentation for NXLog Agent's Google SecOps output module and how to send logs to Google SecOps. - [HTTP(s) (om_http)](https://docs.nxlog.co/agent/current/om/http.md): Documentation for NXLog Agent's HTTP(s) output module and how to send logs via HTTP or HTTPS. - [Java (om_java)](https://docs.nxlog.co/agent/current/om/java.md): Documentation for NXLog Agent's Java output module and how to process logs with Java methods. - [Kafka (om_kafka)](https://docs.nxlog.co/agent/current/om/kafka.md): Documentation for NXLog Agent's Kafka output module and how to publish logs to an Apache Kafka topic - [Null (om_null)](https://docs.nxlog.co/agent/current/om/null.md): Documentation for NXLog Agent's dummy output module. This module can be used for testing, custom log processing, or scheduled execution. - [ODBC (om_odbc)](https://docs.nxlog.co/agent/current/om/odbc.md): Documentation for NXLog Agent's database output module. This module uses an ODBC driver. - [OpenTelemetry Exporter (om_otel)](https://docs.nxlog.co/agent/current/om/otel.md): Documentation for NXLog Agent's OpenTelemetry output module. - [Perl (om_perl)](https://docs.nxlog.co/agent/current/om/perl.md): Documentation for NXLog Agent's Perl output module and how to process logs with Perl subroutines. - [Named Pipes (om_pipe)](https://docs.nxlog.co/agent/current/om/pipe.md): Documentation for NXLog Agent's named pipes output module and how to send logs to a named pipe. - [Prometheus (om_prometheus)](https://docs.nxlog.co/agent/current/om/prometheus.md): Documentation for NXLog Agent's Prometheus output module and how to expose metrics in Prometheus format. - [Python (om_python)](https://docs.nxlog.co/agent/current/om/python.md): Documentation for NXLog Agent's Python output module and how to process logs with Python functions. - [Raijin (om_raijin)](https://docs.nxlog.co/agent/current/om/raijin.md): Documentation for NXLog Agent's Raijin Database output module and how to forward logs to a Raijin Database server. - [Redis (om_redis)](https://docs.nxlog.co/agent/current/om/redis.md): Documentation for NXLog Agent's Redis output module and how to send logs to a Redis server. - [Ruby (om_ruby)](https://docs.nxlog.co/agent/current/om/ruby.md): Documentation for NXLog Agent's Ruby output module and how to process logs with Ruby methods. - [TLS/SSL (om_ssl)](https://docs.nxlog.co/agent/current/om/ssl.md): Documentation for NXLog Agent's TLS/SSL output module and how to send logs over a secure connection. - [TCP (om_tcp)](https://docs.nxlog.co/agent/current/om/tcp.md): Documentation for NXLog Agent's TCP output module and how to send logs over a TCP connection. - [UDP (om_udp)](https://docs.nxlog.co/agent/current/om/udp.md): Documentation for NXLog Agent's UDP output module and how to send logs as UDP datagrams. - [UDP with IP Spoofing (om_udpspoof)](https://docs.nxlog.co/agent/current/om/udpspoof.md): Documentation for NXLog Agent's UDP with IP spoofing output module and how to send logs as UDP datagrams while retaining the source addresses. - [Unix Domain Sockets (om_uds)](https://docs.nxlog.co/agent/current/om/uds.md): Documentation for NXLog Agent's Unix Domain Sockets output module and how to write log events to a local socket. - [WebHDFS (om_webhdfs)](https://docs.nxlog.co/agent/current/om/webhdfs.md): Documentation for NXLog Agent's WebHDFS output module and how to send logs to an Apache Hadoop cluster. - [ZeroMQ (om_zmq)](https://docs.nxlog.co/agent/current/om/zmq.md): Documentation for NXLog Agent's ZeroMQ output module and how to send logs with ZeroMQ. ### Extension Modules - [Extension Modules](https://docs.nxlog.co/agent/current/xm/index.md): Modules that extend NXLog Agent functionality and cannot be used in a route. - [Remote Management (xm_admin)](https://docs.nxlog.co/agent/current/xm/admin.md): Documentation for NXLog Agent's remote management extension and how to send commands to NXLog Agent remotely. - [AIX Auditing (xm_aixaudit)](https://docs.nxlog.co/agent/current/xm/aixaudit.md): Documentation for NXLog Agent's AIX Auditing extension and how to parse AIX Audit events. - [Apple System Logs (xm_asl)](https://docs.nxlog.co/agent/current/xm/asl.md): Documentation for NXLog Agent's Apple System Logs extension and how to parse Apple System log files. - [Automatic Data Parser (xm_autoparse)](https://docs.nxlog.co/agent/current/xm/autoparse.md): Documentation for NXLog Agent's Automatic Data Parser extension and how to automatically detect the format of incoming telemetry data and parse it into structured fields. - [Basic Security Module Auditing (xm_bsm)](https://docs.nxlog.co/agent/current/xm/bsm.md): Documentation for NXLog Agent's Basic Security Module Auditing extension and how to parse BSM Auditing events. - [Common Event Format (xm_cef)](https://docs.nxlog.co/agent/current/xm/cef.md): Documentation for NXLog Agent's ArcSight Common Event Format extension and how to parse log events in the CEF format. - [Character Set Conversion (xm_charconv)](https://docs.nxlog.co/agent/current/xm/charconv.md): Documentation for NXLog Agent's character set conversion extension and how to convert strings between different character sets (code pages). - [Encryption (xm_crypto)](https://docs.nxlog.co/agent/current/xm/crypto.md): Documentation for NXLog Agent's encryption extension and how to encrypt and decrypt log files. - [Delimiter-Separated Values (xm_csv)](https://docs.nxlog.co/agent/current/xm/csv.md): This topic provides details on functions and procedures for working with data formatted as comma-separated values (CSV). - [External Programs (xm_exec)](https://docs.nxlog.co/agent/current/xm/exec.md): This topic elaborates on how to run external scripts or programs when collecting logs with NXLog. - [File Lists (xm_filelist)](https://docs.nxlog.co/agent/current/xm/filelist.md): Documentation for NXLog Agent's file list extension and how to implement file-based allow and block lists with NXLog Agent. - [File Operations (xm_fileop)](https://docs.nxlog.co/agent/current/xm/fileop.md): Documentation for NXLog Agent's file operations extension and how to manipulate files with NXLog Agent. - [GELF (xm_gelf)](https://docs.nxlog.co/agent/current/xm/gelf.md): Documentation for NXLog Agent's Graylog Extended Log Format extension and how to parse log events in the GELF format. - [Go (xm_go)](https://docs.nxlog.co/agent/current/xm/go.md): Documentation for NXLog Agent's Go extension and how to process logs with Go methods. - [Grok (xm_grok)](https://docs.nxlog.co/agent/current/xm/grok.md): Documentation for NXLog Agent's Grok extension and how to parse log events with Grok patterns. - [Health check (xm_hc)](https://docs.nxlog.co/agent/current/xm/hc.md): Documentation for NXLog Agent's health check extension and how to check if NXLog Agent is up and running. - [Java (xm_java)](https://docs.nxlog.co/agent/current/xm/java.md): Documentation for NXLog Agent's Java extension and how to process logs with Java methods. - [JSON (xm_json)](https://docs.nxlog.co/agent/current/xm/json.md): Documentation for NXLog Agent's JSON extension and how to parse JSON data and convert data to JSON format. - [Key-Value Pairs (xm_kvp)](https://docs.nxlog.co/agent/current/xm/kvp.md): Documentation for NXLog Agent's key-value pairs extension and how to parse log events formatted as key-value pairs. - [LEEF (xm_leef)](https://docs.nxlog.co/agent/current/xm/leef.md): Documentation for NXLog Agent's Log Event Extended Format extension and how to parse log events in the LEEF format. - [Microsoft DNS Server (xm_msdns)](https://docs.nxlog.co/agent/current/xm/msdns.md): Documentation for NXLog Agent's Microsoft DNS Server extension and how to parse Microsoft DNS Server log events. - [Multiline Parser (xm_multiline)](https://docs.nxlog.co/agent/current/xm/multiline.md): Documentation for NXLog Agent's multiline parser extension and how to parse multiline log events. - [NetFlow (xm_netflow)](https://docs.nxlog.co/agent/current/xm/netflow.md): Documentation for NXLog Agent's NetFlow extension and how to parse NetFlow payloads collected over UDP. - [Microsoft Network Policy Server (xm_nps)](https://docs.nxlog.co/agent/current/xm/nps.md): Documentation for NXLog Agent's Microsoft Network Policy Server extension and how to parse NPS log events. - [Pattern Matcher (xm_pattern)](https://docs.nxlog.co/agent/current/xm/pattern.md): Documentation for NXLog Agent's pattern matching extension and how to filter logs with XML-based patterns. - [Perl (xm_perl)](https://docs.nxlog.co/agent/current/xm/perl.md): Documentation for NXLog Agent's Perl extension and how to process logs with Perl methods. - [Python (xm_python)](https://docs.nxlog.co/agent/current/xm/python.md): Documentation for NXLog Agent's Python extension and how to process logs with Python functions. - [Resolver (xm_resolver)](https://docs.nxlog.co/agent/current/xm/resolver.md): Documentation for NXLog Agent's resolver extension and how to resolve IPs, User IDs, and Group IDs. - [Rewrite (xm_rewrite)](https://docs.nxlog.co/agent/current/xm/rewrite.md): Documentation for NXLog Agent's rewrite extension and how to rewrite log events. - [Ruby (xm_ruby)](https://docs.nxlog.co/agent/current/xm/ruby.md): Documentation for NXLog Agent's Ruby extension and how to process logs with Ruby methods. - [SAP (xm_sap)](https://docs.nxlog.co/agent/current/xm/sap.md): Documentation for NXLog Agent's SAP extension and how to process SAP security audit logs. - [SNMP Traps (xm_snmp)](https://docs.nxlog.co/agent/current/xm/snmp.md): Documentation for NXLog Agent's Simple Network Management Protocol extension and how to parse SNMP trap messages. - [Syslog (xm_syslog)](https://docs.nxlog.co/agent/current/xm/syslog.md): Documentation for NXLog Agent's syslog extension and how to parse syslog messages. - [Transform (xm_transform)](https://docs.nxlog.co/agent/current/xm/transform.md): Documentation for NXLog Agent's data transform extension and how to normalize log events. - [W3C (xm_w3c)](https://docs.nxlog.co/agent/current/xm/w3c.md): Documentation for NXLog Agent's W3C Extended Log File Format extension and how to process log in the W3C log format. - [WTMP (xm_wtmp)](https://docs.nxlog.co/agent/current/xm/wtmp.md): Documentation for NXLog Agent's wtmp file extension and how to parse wtmp log files. - [XML (xm_xml)](https://docs.nxlog.co/agent/current/xm/xml.md): Documentation for NXLog Agent's XML extension and how to parse log events in the XML format. - [Compression (xm_zlib)](https://docs.nxlog.co/agent/current/xm/zlib.md): Documentation for NXLog Agent's compression extension and how to compress and decompress log files. ### Processor Modules - [Processor Modules](https://docs.nxlog.co/agent/current/pm/index.md): Modules for additional log processing that can be used in an NXLog Agent route. - [Blocker (pm_blocker)](https://docs.nxlog.co/agent/current/pm/blocker.md): Documentation for NXLog Agent's log processing blocker module. - [Buffer (pm_buffer)](https://docs.nxlog.co/agent/current/pm/buffer.md): Documentation for NXLog Agent's log buffering module. - [Event Correlator (pm_evcorr)](https://docs.nxlog.co/agent/current/pm/evcorr.md): Documentation for NXLog Agent's event correlation module. - [HMAC Message Integrity (pm_hmac)](https://docs.nxlog.co/agent/current/pm/hmac.md): Documentation for NXLog Agent's checksum module. - [HMAC Message Integrity Checker (pm_hmac_check)](https://docs.nxlog.co/agent/current/pm/hmac-check.md): Documentation for NXLog Agent's checksum validator module. - [De-Duplicator (pm_norepeat)](https://docs.nxlog.co/agent/current/pm/norepeat.md): Documentation for NXLog Agent's duplicate logs detector module. - [Null (pm_null)](https://docs.nxlog.co/agent/current/pm/null.md): Documentation for NXLog Agent's dummy processor module. This module can be used for testing, custom log processing, or scheduled execution. - [Pattern Matcher (pm_pattern)](https://docs.nxlog.co/agent/current/pm/pattern.md): Documentation for NXLog Agent's efficient pattern-matching module. ### Troubleshooting - [Troubleshooting](https://docs.nxlog.co/agent/current/troubleshoot/index.md): Tips that help you troubleshoot NXLog Agent and solutions to common issues. - [Viewing the NXLog Agent logs](https://docs.nxlog.co/agent/current/troubleshoot/nxlog-agent-logs.md): NXLog Agent logs messages about its operation to a file. You can customize the log file path and log level. - Common issues - [Startup errors](https://docs.nxlog.co/agent/current/troubleshoot/startup-errors.md): Check the NXLog Agent log file to troubleshoot startup errors. - [Configuration errors](https://docs.nxlog.co/agent/current/troubleshoot/configuration-errors.md): This page provides troubleshooting tips and explanations for errors related to NXLog Agent misconfiguration. - [Processing errors](https://docs.nxlog.co/agent/current/troubleshoot/processing-errors.md): NXLog Agent implements flow control to prevent data loss. When it's activated, input module instances stop collecting logs. Reaching the system's open file limit also affects NXLog Agent performance. - [Log access errors](https://docs.nxlog.co/agent/current/troubleshoot/log-access-errors.md): Failure to access log files is most likely caused by NXLog Agent not having the correct permissions. - [Connection errors](https://docs.nxlog.co/agent/current/troubleshoot/connection-errors.md): TCP connection errors are often caused by a firewall blocking communication, resulting in NXLog Agent failing to connect to the remote host. - [TLS/SSL errors](https://docs.nxlog.co/agent/current/troubleshoot/tls-ssl-errors.md): Most TLS/SSL errors are related to certificate verification. The OpenSSL tool helps you troubleshoot such issues. - [Performance issues](https://docs.nxlog.co/agent/current/troubleshoot/performance-issues.md): Use SIGNALS or the Remote Management (xm_admin) module to troubleshoot NXLog Agent performance issues. - [Generating test data](https://docs.nxlog.co/agent/current/troubleshoot/generating-test-data.md): Use NXLog Agent's test input module, netcat, or a script to generate logs for testing. - [Debugging NXLog Agent](https://docs.nxlog.co/agent/current/troubleshoot/debug-nxlog-agent.md): Use core dumps and Valgrind on Linux and ProcDump and DebugView on Windows to debug NXLog Agent crashes and memory usage. ### Release notes - [Release notes](https://docs.nxlog.co/agent/current/release-notes.md): Release notes updates for NXLog Agent. ### Changelog - [Changelog](https://docs.nxlog.co/agent/current/changelog.md): Changelog updates for NXLog Agent. ### Known issues - [Known issues](https://docs.nxlog.co/agent/current/known-issues.md): The following is a list of known issues for NXLog Agent. ### Other pages - [Fields by providers](https://docs.nxlog.co/agent/current/im/msvistalog_providers.md): This table lists the most common Windows event providers and their associated fields. - [JSON fields](https://docs.nxlog.co/agent/current/im/pcap-json-fields.md): The `ios` field contains the number of elements in the `io` array. - [NXLog Agent Reference Manual](https://docs.nxlog.co/agent/current/index.md): NXLog Agent reference documentation for advanced users. - [NXLog Agent Remote Management API definition](https://docs.nxlog.co/agent/current/xm/admin-api.md): The following is a list of _xm_admin_ API endpoints, how to structure requests, and the expected response. - [NXLog pattern database schema reference](https://docs.nxlog.co/agent/current/xm/pattern-definition.md): Pattern database schema reference for NXLog Agent. - [Protocols and fields](https://docs.nxlog.co/agent/current/im/pcap-protocols.md): A list of protocols supported by the Packet capture (im_pcap) module. ## NXLog Integration Guides ### CMS - [CMS](https://docs.nxlog.co/integrations/cms/index.md): Browse integration guides for collecting operational and audit logs from SharePoint, WordPress, PrestaShop, and Drupal content management systems. - [Microsoft SharePoint](https://docs.nxlog.co/integrations/cms/sharepoint.md): How to collect Microsoft SharePoint logs with NXLog Agent. - [WordPress, PrestaShop, and Drupal](https://docs.nxlog.co/integrations/cms/cms-systems.md): How to collect logs from Content Management Systems with NXLog Agent. ### Databases - [Databases](https://docs.nxlog.co/integrations/db/index.md): Browse integration guides for collecting logs from and forwarding logs to databases hosted on MS SQL Server, MongoDB, Oracle Database, and more. - [Elasticsearch](https://docs.nxlog.co/integrations/db/elasticsearch-kibana.md): How to send logs to Elasticsearch, Kibana, and Logstash with NXLog Agent. - [Microsoft SQL Server](https://docs.nxlog.co/integrations/db/mssql-server.md): A complete guide to collecting Microsoft SQL Server security and audit logs and collecting and forwarding logs to a Microsoft SQL server database. - [MongoDB](https://docs.nxlog.co/integrations/db/mongodb.md): Configure NXLog Agent to collect data from MongoDB. - [Oracle Database](https://docs.nxlog.co/integrations/db/oracle-database.md): Collect Oracle Database logs and read from and write to an Oracle database with NXLog Agent. - [Raijin Database Engine](https://docs.nxlog.co/integrations/db/raijin.md): How to send logs to Raijin Server with NXLog Agent. - [SAP HANA](https://docs.nxlog.co/integrations/misc/sap.md#sap-hana-logs) ### Data Streaming - [Data Streaming](https://docs.nxlog.co/integrations/data-stream/index.md): Browse integration guides for streaming logs to Amazon S3, Apache NiFi, and Microsoft Azure Event Hubs using HTTPS or the Kafka protocol. - [Amazon Web Services (AWS)](https://docs.nxlog.co/integrations/storage/amazon-aws.md): How to collect logs from Amazon Web Services (AWS) with NXLog Agent. - [Apache NiFi](https://docs.nxlog.co/integrations/data-stream/apache-nifi.md): Sending and receiving logs from Apache NiFi with NXLog Agent. - [Microsoft Azure Event Hubs](https://docs.nxlog.co/integrations/data-stream/microsoft-azure-event-hubs.md): How to send log data to Microsoft Azure Event Hubs with NXLog Agent. ### DHCP Logs - [DHCP Logs](https://docs.nxlog.co/integrations/dhcp/index.md): Browse integration guides for configuring and collecting DHCP logs from ISC DHCPd, ISC dhclient, Windows DHCP Server, and Windows DHCP Client. - [ISC DHCP server (DHCPd)](https://docs.nxlog.co/integrations/dhcp/dhcpd.md): How to collect DHCPd server logs with NXLog Agent. - [ISC DHCP client (dhclient)](https://docs.nxlog.co/integrations/dhcp/dhclient.md): How to collect DHCPd client logs with NXLog Agent. - [Windows DHCP server](https://docs.nxlog.co/integrations/dhcp/windows-dhcp-server.md): Collect Windows DHCP Server logs with NXLog Agent. - [Windows DHCP client](https://docs.nxlog.co/integrations/dhcp/windows-dhcp-client.md): Collecting Windows DHCP client logs with NXLog Agent. ### DNS Monitoring - [DNS Monitoring](https://docs.nxlog.co/integrations/dns/index.md): Learn how to configure DNS logging and collect BIND 9 logs, passive DNS network packets, and Windows DNS Server logs with NXLog Agent. - [BIND 9](https://docs.nxlog.co/integrations/dns/dns-monitoring-linux.md): Collect BIND 9 DNS server logs with NXLog Agent. - [Passive DNS monitoring](https://docs.nxlog.co/integrations/dns/passive-dns-monitoring.md): Passive DNS monitoring using network packet capture. - [Windows DNS Server](https://docs.nxlog.co/integrations/dns/dns-monitoring-windows.md): Collecting Windows DNS Server logs from ETW providers, Sysmon, and Windows Event Log with NXLog Agent. ### ICS/SCADA - [ICS/SCADA](https://docs.nxlog.co/integrations/ics/index.md): Browse integration guides for collecting SCADA and ICS logs from Schneider Electric, Siemens, ABB, AVEVA, GE CIMPLICITY, APC, and Yokogawa systems. - [ABB MicroSCADA Pro SYS600](https://docs.nxlog.co/integrations/ics/abb-microscada-pro-sys600.md): How to collect logs from ABB MicroSCADA Pro SYS600 with NXLog Agent - [APC Automatic Transfer Switch](https://docs.nxlog.co/integrations/ics/apc.md): Collect logs from APC Automatic Transfer Switches with NXLog Agent. - [AVEVA System Platform](https://docs.nxlog.co/integrations/ics/aveva-system-platform.md): Collect logs from AVEVA System Platform with NXLog Agent. - [General Electric CIMPLICITY](https://docs.nxlog.co/integrations/ics/general-electric-cimplicity.md): How to collect log data from General Electric CIMPLICITY with NXLog Agent. - [Industrial Control System protocols](https://docs.nxlog.co/integrations/ics/industrial-control-system-protocols.md): How to passively monitor Industrial Control Systems network traffic with NXLog Agent. - [Schneider Electric Citect SCADA](https://docs.nxlog.co/integrations/ics/schneider-electric-citect-scada.md): How to collect logs from Schneider Electric Citect SCADA with NXLog Agent. - [Schneider Electric EcoStruxure Process Expert](https://docs.nxlog.co/integrations/ics/schneider-electric-ecostruxure.md): How to collect logs from Schneider Electric EcoStruxure Process Expert with NXLog Agent. - [Siemens SICAM SCC](https://docs.nxlog.co/integrations/ics/siemens-sicam-scc.md): How to collect logs from Siemens SICAM SCC with NXLog Agent. - [Siemens SICAM PAS/PQS](https://docs.nxlog.co/integrations/ics/siemens-sicam-pas-pqs.md): How to collect logs from Siemens Sicam PAS/PQS Process with NXLog Agent. - [Siemens SIMATIC PCS 7](https://docs.nxlog.co/integrations/ics/siemens-simatic-pcs-7.md): How to collect logs from Siemens SIMATIC PCS 7 with NXLog Agent. - [Yokogawa FAST/TOOLS](https://docs.nxlog.co/integrations/ics/yokogawa-fast-tools.md): How to collect log data from Yokogawa FAST/TOOLS with NXLog Agent. ### IDS/IPS - [IDS/IPS](https://docs.nxlog.co/integrations/ids/index.md): Browse integration guides for collecting intrusion detection logs from Microsoft Defender for Identity, Rapid7 InsightIDR, Snort, Symantec, and Zeek. - [Microsoft Defender for Identity](https://docs.nxlog.co/integrations/ids/microsoft-defender-for-identity.md): How to collect logs from Microsoft Defender for Identity with NXLog Agent. - [Rapid7 InsightIDR](https://docs.nxlog.co/integrations/siem/rapid7.md): How to send logs to Rapid7 InsightIDR SIEM with NXLog Agent. - [Snort](https://docs.nxlog.co/integrations/ids/snort.md): Practical examples of collecting and processing Snort logs from the Snort Network Intrusion Detection System. - [Symantec Endpoint Protection](https://docs.nxlog.co/integrations/network/symantec-endpoint.md): How to collect logs from the Broadcom Symantec Endpoint Protection MSSQL server database to respond to online threats. - [Zeek Network Security Monitor](https://docs.nxlog.co/integrations/ids/zeek.md): Collecting and processing logs from Zeek Network Security Monitor with NXLog Agent. ### Log Formats - [Log Formats](https://docs.nxlog.co/integrations/format/index.md): Learn how to parse and convert logs between common formats including ArcSight CEF, CEE, LEEF, Elastic Common Schema, Snare, and BSD or IETF syslog. - [ArcSight Common Event Format (CEF)](https://docs.nxlog.co/integrations/format/cef-logging.md): Collecting and forwarding logs in the Common Event Format (CEF) with NXLog Agent. - [Common Event Expression (CEE)](https://docs.nxlog.co/integrations/format/cee.md): Collect and forward CEE logs with NXLog Agent. - [Elastic Common Schema (ECS)](https://docs.nxlog.co/integrations/format/elastic-common-schema.md): This guide provides examples of how to send logs that comply with the Elastic Common Schema (ECS). - [Log Event Extended Format (LEEF)](https://docs.nxlog.co/integrations/format/leef.md): Generate, send, and collect LEEF logs for use with IBM Security QRadar. - [Snare](https://docs.nxlog.co/integrations/siem/snare.md): How to parse Snare logs into structured data and generate logs in the Snare format. - [Syslog](https://docs.nxlog.co/integrations/format/syslog.md): Explains BSD and IETF syslog formats and how NXLog Agent collects, parses, filters, and forwards syslog using files and the network, including structured data. ### Mail Servers - [Mail Servers](https://docs.nxlog.co/integrations/mail/index.md): Learn how to configure mail server logging from Microsoft Exchange and Postfix and collect logs with NXLog Agent. - [Microsoft Exchange](https://docs.nxlog.co/integrations/mail/microsoft-exchange.md): Configure and collect different types of Microsoft Exchange logs with NXLog Agent. - [Postfix](https://docs.nxlog.co/integrations/mail/postfix.md): How to collect logs from Postfix with NXLog Agent. ### Networking - [Networking](https://docs.nxlog.co/integrations/network/index.md): Browse integration guides for collecting logs from network devices like Cisco ASA, Microsoft Active Directory, F5 BIG-IP, Check Point, and more. - [Brocade switches](https://docs.nxlog.co/integrations/network/brocade.md): Collect logs from Brocade switches with NXLog Agent. - [Check Point](https://docs.nxlog.co/integrations/network/checkpoint.md): Collect Check Point OPSEC LEA logs with NXLog Agent. - [Cisco ACS](https://docs.nxlog.co/integrations/network/cisco-acs.md): Collect Cisco ACS logs with NXLog Agent. - [Cisco ASA](https://docs.nxlog.co/integrations/network/cisco-asa.md): Collect logs from Cisco Adaptive Security Appliance (ASA) devices with NXLog Agent. - [F5 BIG-IP](https://docs.nxlog.co/integrations/network/f5-bigip.md): Configuring F5 BIG-IP traffic and audit logging and collecting the logs with NXLog Agent. - [FreeRADIUS](https://docs.nxlog.co/integrations/network/freeradius.md): How to process FreeRADIUS authentication and accounting logs with NXLog Agent. - [HP ProCurve](https://docs.nxlog.co/integrations/network/hp-procurve.md): How to collect logs from HP ProCurve switches with NXLog Agent. - [Microsoft Active Directory (AD)](https://docs.nxlog.co/integrations/network/microsoft-ad.md): Collecting Microsoft Active Directory Domain Controller logs with NXLog Agent. - [Microsoft Routing and Remote Access Service (RRAS)](https://docs.nxlog.co/integrations/network/microsoft-rras.md): How to configure and collect various logs created by Remote Access services. - [Microsoft System Center Configuration Manager](https://docs.nxlog.co/integrations/network/microsoft-sccm.md): How to collect Microsoft System Center Configuration Manager logs with NXLog Agent. - [Microsoft System Center Endpoint Protection](https://docs.nxlog.co/integrations/network/microsoft-system-center-endpoint-protection.md): How to collect and parse logs from Microsoft System Center Endpoint Protection with NXLog Agent. - [Microsoft System Center Operations Manager](https://docs.nxlog.co/integrations/network/microsoft-scom.md): How to collect Microsoft System Center Operations Manager logs with NXLog Agent. - [Nagios Log Server](https://docs.nxlog.co/integrations/network/nagios-log-server.md): How to send logs to Nagios Log Server with NXLog Agent. - [Nessus Vulnerability Scanner](https://docs.nxlog.co/integrations/network/nessus.md): How to configure Nessus scans to create logs and collect them with NXLog Agent. - [Symantec Endpoint Protection](https://docs.nxlog.co/integrations/network/symantec-endpoint.md): How to collect logs from the Broadcom Symantec Endpoint Protection MSSQL server database to respond to online threats. - [Trellix ePolicy Orchestrator](https://docs.nxlog.co/integrations/network/trellix-epo.md): How to collect events and audit logs from Trellix ePolicy Orchestrator with NXLog Agent - [Ubiquiti UniFi](https://docs.nxlog.co/integrations/network/unifi.md): Configure NXLog Agent to collect logs from Ubiquiti UniFi access points with the UniFi Controller. - [Windows Firewall](https://docs.nxlog.co/integrations/network/windows-firewall.md): How to collect Windows Firewall logs with NXLog Agent. - [Windows Server Failover Clustering](https://docs.nxlog.co/integrations/network/windows-server-failover-clustering.md): How to collect WSFC logs from Windows Event Log and ETW. ### Operating System - [Operating System](https://docs.nxlog.co/integrations/os/index.md): Browse integration guides for collecting operating system logs from Linux, Windows Event Log, macOS, NetApp ONTAP, Osquery, and Sysmon. - [File Integrity Monitoring](https://docs.nxlog.co/integrations/os/fim.md): File integrity monitoring on Linux and Windows using NXLog Agent. - [Linux Audit](https://docs.nxlog.co/integrations/os/linux-audit.md): Learn about the Linux Audit system, its components auditd, audisp, and auditctl, and how to collect Linux audit logs. - [Linux system logs](https://docs.nxlog.co/integrations/os/linux-logs.md): Collecting system logs from a Linux system with NXLog Agent. - [macOS system logs](https://docs.nxlog.co/integrations/os/macos.md): NXLog Agent provides specialized modules to collect ULS and Endpoint Security auditing logs from macOS. - [NetApp ONTAP](https://docs.nxlog.co/integrations/os/netapp.md): How to collect logs from NetApp with NXLog Agent. - [Osquery](https://docs.nxlog.co/integrations/os/osquery.md): How to collect security and log-monitoring data from Osquery with NXLog Agent. - [Sysmon](https://docs.nxlog.co/integrations/os/sysmon.md): How to collect Sysmon logs on Windows and Linux. - Windows - [Windows AppLocker](https://docs.nxlog.co/integrations/os/windows-applocker.md): How to collect Windows AppLocker logs with NXLog Agent. - [Windows Command Line Auditing](https://docs.nxlog.co/integrations/os/windows-command-line-auditing.md): How to collect and parse windows command line auditing logs with NXLog Agent. - [Windows Event Forwarding](https://docs.nxlog.co/integrations/os/windows-event-forwarding.md): A comprehensive guide to set up Windows Event Forwarding to collect events from Windows machines remotely. - [Windows Event Log](https://docs.nxlog.co/integrations/os/windows-event-log.md): A comprehensive overview of Windows Event Log, including Event IDs, Event Channels, Providers, and how to collect, filter, and forward Windows logs. - [Windows Group Policy](https://docs.nxlog.co/integrations/os/windows-gpo.md): Collect and parse events from Windows Group Policy with NXLog Agent. - [Windows PowerShell](https://docs.nxlog.co/integrations/os/powershell.md): How to collect PowerShell logs and use PowerShell in an NXLog Agent configuration. - [Using PowerShell scripts](https://docs.nxlog.co/integrations/os/powershell-scripts.md): How to generate, process, and forward logs using PowerShell scripts and NXLog Agent. - [Logging PowerShell activity](https://docs.nxlog.co/integrations/os/powershell-activity.md): How to collect PowerShell logs with NXLog Agent. - [Windows Resource Checker](https://docs.nxlog.co/integrations/os/windows-resource-checker.md): How to collect Windows Resource Checker logs with NXLog Agent. - [Windows Security audit](https://docs.nxlog.co/integrations/os/windows-security-audit.md): How to configure Windows audit policies and collect audit events from Windows Event Log. - [Windows Task Scheduler](https://docs.nxlog.co/integrations/os/windows-task-scheduler.md): Collecting Windows Task Scheduler logs with NXLog Agent. - [Windows Time service](https://docs.nxlog.co/integrations/os/windows-time.md): How to collect Windows Time service logs with NXLog Agent. - [Windows Update](https://docs.nxlog.co/integrations/os/windows-update.md): How to collect Windows Update logs with NXLog Agent. - [Windows USB auditing](https://docs.nxlog.co/integrations/os/windows-usb-auditing.md): How to collect USB activity logs with NXLog Agent. - [Windows Management Instrumentation (WMI)](https://docs.nxlog.co/integrations/os/wmi.md): How to collect Windows Management Instrumentation logs with NXLog Agent. ### SIEM - [SIEM](https://docs.nxlog.co/integrations/siem/index.md): Browse integration guides for forwarding logs to SIEM platforms including Splunk, Microsoft Sentinel, IBM QRadar, Google SecOps, and Graylog. - [Devo](https://docs.nxlog.co/integrations/siem/devo.md): How to send logs to Devo with NXLog Agent. - [Elastic Cloud](https://docs.nxlog.co/integrations/siem/elastic-cloud.md): How to send logs to Elastic Cloud via the Elasticsearch REST API. - [Google SecOps](https://docs.nxlog.co/integrations/siem/google-security-operations.md): Configure NXLog Agent to send logs to Google SecOps. - [Graylog](https://docs.nxlog.co/integrations/siem/graylog.md): Convert logs in any format to GELF and send them to Graylog over TCP or UDP. - [IBM QRadar](https://docs.nxlog.co/integrations/siem/ibm-qradar.md): Send logs to IBM QRadar with NXLog Agent. - [LogPoint](https://docs.nxlog.co/integrations/siem/logpoint.md): How to send logs to LogPoint as syslog over TCP or UDP, including examples of Windows Event Log and JSON-formatted logs. - [McAfee Enterprise Security Manager](https://docs.nxlog.co/integrations/siem/mcafee-esm.md): Sending different log types to McAfee Enterprise Security Manager with NXLog Agent. - [Micro Focus ArcSight Logger](https://docs.nxlog.co/integrations/siem/microfocus-arcsight-logger.md): How to send logs to Micro Focus ArcSight Logs in Common Event Format (CEF), including examples of Windows Event Log and Linux syslog. - [Microsoft Sentinel](https://docs.nxlog.co/integrations/siem/microsoft-sentinel.md): A comprehensive guide to configure and send logs to Microsoft Sentinel. - [Rapid7 InsightIDR](https://docs.nxlog.co/integrations/siem/rapid7.md): How to send logs to Rapid7 InsightIDR SIEM with NXLog Agent. - [RSA NetWitness](https://docs.nxlog.co/integrations/siem/rsa-netwitness.md): How to send logs to RSA NetWitness with NXLog Agent. - [Snare Central](https://docs.nxlog.co/integrations/siem/snare.md#generating-snare-logs) - [SolarWinds Loggly](https://docs.nxlog.co/integrations/siem/solarwinds-loggly.md): How to collect and parse logs with NXLog Agent to forward them to SolarWinds Loggly. - [Splunk](https://docs.nxlog.co/integrations/siem/splunk.md): Send any type of log to Splunk over UDP, TCP/TLS, or HTTP(S). - [Sumo Logic](https://docs.nxlog.co/integrations/siem/sumo-logic.md): Forward logs and host metrics to Sumo Logic over TCP or HTTPS with NXLog Agent. ### Storage - [Storage](https://docs.nxlog.co/integrations/storage/index.md): Browse integration guides for collecting logs from storage devices such as Dell EqualLogic, Dell PowerVault, Amazon S3, Promise VTrak, and Synology NAS. - [Amazon Web Services (AWS)](https://docs.nxlog.co/integrations/storage/amazon-aws.md): How to collect logs from Amazon Web Services (AWS) with NXLog Agent. - [Dell EqualLogic](https://docs.nxlog.co/integrations/storage/dell-equallogic.md): How to collect logs from Dell EqualLogic SANs with NXLog Agent. - [Dell PowerVault MD series](https://docs.nxlog.co/integrations/storage/dell-powervault.md): How to collect logs from Dell PowerVault MS series with NXLog Agent. - [Promise VTrak](https://docs.nxlog.co/integrations/storage/promise.md): Collect logs from Promise storage devices with NXLog Agent. - [Synology DiskStation](https://docs.nxlog.co/integrations/storage/synology.md): How to collect logs from a Synology DiskStation NAS with NXLog Agent. ### Virtualization - [Virtualization](https://docs.nxlog.co/integrations/virtualization/index.md): Learn how to collect logs and metadata from virtualization platforms including Docker, Kubernetes, VMware vCenter, AWS, Azure, and Google Cloud. - [Cloud Instance Metadata](https://docs.nxlog.co/integrations/virtualization/cloud-metadata.md): Collect and add cloud instance metadata to logs with NXLog Agent. - [Docker](https://docs.nxlog.co/integrations/virtualization/docker.md): Collect logs from Docker containers with NXLog Agent. - [Kubernetes](https://docs.nxlog.co/integrations/virtualization/kubernetes.md): How to collect Kubernetes application, system, and audit logs, with examples of how to deploy a logging agent DaemonSet or sidecar. - [VMware vCenter](https://docs.nxlog.co/integrations/virtualization/vmware.md): How to collect logs from VMware vCenter with NXLog Agent. ### Web Servers - [Web Servers](https://docs.nxlog.co/integrations/web-server/index.md): Learn how to collect and parse web server access and error logs from Apache HTTP Server, Apache Tomcat, Microsoft IIS, and nginx. - [Apache HTTP Server](https://docs.nxlog.co/integrations/web-server/apache-httpd.md): How to collect Apache HTTP Server logs with NXLog Agent. - [Apache Tomcat](https://docs.nxlog.co/integrations/web-server/apache-tomcat.md): Collect and parse messages from Tomcat container log files. - [Microsoft IIS](https://docs.nxlog.co/integrations/web-server/microsoft-iis.md): How to collect Microsoft IIS logs with NXLog Agent. - [nginx](https://docs.nxlog.co/integrations/web-server/nginx.md): Collecting and parsing nginx error and access logs with NXLog Agent. ### Miscellaneous - [Miscellaneous](https://docs.nxlog.co/integrations/misc/index.md): Browse integration guides for Dell iDRAC, .NET applications, browser history, Logstash, SafeNet KeySecure, and SAP log collection. - [Dell iDRAC](https://docs.nxlog.co/integrations/misc/dell-idrac.md): How to collect Dell iDRAC logs with NXLog Agent. - [.NET application logs](https://docs.nxlog.co/integrations/misc/dotnet.md): Collect Microsoft .NET application logs with NXLog Agent. - [Browser history logs](https://docs.nxlog.co/integrations/misc/browser-history.md): Collecting browser history logs with NXLog Agent. - [Logstash](https://docs.nxlog.co/integrations/misc/logstash.md): Sending and receiving logs to and from Logstash over TCP, UDP, and HTTPS with NXLog Agent. - [SafeNet KeySecure](https://docs.nxlog.co/integrations/misc/safenet-keysecure.md): How to collect logs from Safenet KeySecure devices with NXLog Agent. - [SAP](https://docs.nxlog.co/integrations/misc/sap.md): Collect logs from various SAP components and parse them into a user-friendly format with NXLog Agent. ### Other pages - [NXLog Integration Guides](https://docs.nxlog.co/integrations/index.md): Browse integration guides for collecting logs from operating systems, applications, and devices and forwarding them to destinations like Google SecOps, Graylog, and Snare. ## NXLog Platform Developer Guide - [Agent Management API](https://docs.nxlog.co/api/agent-management/index.md): Guides for using the Agent Management API to authenticate requests, enroll agents, create and update configurations and enrollment rules, and renew agent certificates. ### About the API - [About the API](https://docs.nxlog.co/api/agent-management/agent-management-api-overview.md): Learn the Agent Management API concepts, entities, endpoints, HTTP methods, request headers, and response codes for managing your NXLog Agent fleet programmatically. ### Using the API - [Finding your organization ID](https://docs.nxlog.co/api/agent-management/organization.md): Find your NXLog Platform organization ID on the Organization overview page, where the last part of the URL is the ID required for all Agent Management API requests. - [Authentication](https://docs.nxlog.co/api/agent-management/authentication.md): Generate a Personal Access Token (PAT) from the NXLog Platform UI to authenticate requests to the Agent Management API. - [Pagination](https://docs.nxlog.co/api/agent-management/pagination.md): Learn how to paginate Agent Management API GET requests that return multiple entities by using the offset and limit query parameters. ### Agents - [Enroll agents](https://docs.nxlog.co/api/agent-management/enroll-agents.md): The Agent Management API provides the agents endpoint and the enroll command to enroll an agent to NXLog Platform. - [Enroll agents by rules](https://docs.nxlog.co/api/agent-management/enroll-agents-by-rules.md): The Agent Management API provides the agents endpoint and the enroll-by-rules command to enroll agents to NXLog Platform using predefined enrollment rules. - [Renew TLS/SSL certificates](https://docs.nxlog.co/api/agent-management/renew-agent-certificate.md): The Agent Management API provides the agents endpoint and the certificate/renew command to renew an agent's TLS/SSL certificate. - [Sync agent configuration](https://docs.nxlog.co/api/agent-management/sync-agent-configuration.md): The Agent Management API provides the agents endpoint and the files-sync command to synchronize an agent's configuration with Agent Manager. ### Configurations - [Create a configuration](https://docs.nxlog.co/api/agent-management/create-configuration.md): The Agent Management API provides the templates endpoint to create new configurations. - [Update configurations](https://docs.nxlog.co/api/agent-management/update-configurations.md): Update existing agent configurations by sending a PATCH request to the templates endpoint. ### Enrollment rules - [Create a rule](https://docs.nxlog.co/api/agent-management/create-enrollment-rule.md): The Agent Management API provides the enroll-rules endpoint to create new agent enrollment rules. - [Update rules](https://docs.nxlog.co/api/agent-management/update-enrollment-rules.md): Update existing enrollment rules by sending a PATCH request to the enroll-rules endpoint. ### API reference - [API reference](https://docs.nxlog.co/api/agent-management/api-reference.md): Browse Agent Management API endpoints and schemas in the Swagger UI of your NXLog Platform instance or download the OpenAPI specification to view it in any OpenAPI viewer. ### Other pages - [NXLog Platform Developer Guide](https://docs.nxlog.co/api/index.md): Automate your NXLog Platform workflows with the NXLog Platform APIs, including the Agent Management API for configuring, monitoring, and managing your NXLog Agent fleet. ## Release Notes - [NXLog Platform](https://docs.nxlog.co/release-notes/on-premises/release-notes.md): NXLog Platform release updates. ### Changelog - [Changelog](https://docs.nxlog.co/release-notes/on-premises/changelog.md): Changelog updates for NXLog Platform. ### Known issues - [Known issues](https://docs.nxlog.co/release-notes/on-premises/known-issues.md): The following is a list of known issues for NXLog Platform on-premises.