TopicsSetting it up
Setting it up
Supported PXM versions
The module runs on PXM 26.2.0 and later.
Steps
- Grant a role the right Administrate the PXM Log Exporter (role editor, egos.tech > PXM Log
Exporter) and the core right Administrate Options, which opens the options pages. Creating the
credentials below also needs the core right Manage Credentials. The shipping job “PXM Log Exporter:
ship events” is under System Preferences > Business Processes > ActiveJobs, visible to roles with the right
Administrate under CORE > ActiveJobs in the role editor.
- Grant Administrate the PXM Log Exporter as you would grant the sinks’ credentials: whoever holds it decides where the sinks send. They can point the HTTPS sink at any public address, and the next run or a connection test sends that sink’s credential there: a Splunk HEC token, the generic endpoint’s token, password or header value, or a short-lived Entra access token; a generic endpoint that signs with HMAC gets a signature of the body alone. The Sentinel client secret goes only to Microsoft’s sign-in, and an Event Hubs signature is valid for the configured host only. The right also lets its holder send an HTTPS POST from the tenant’s egress address with headers of their choice, which a service that allows the platform’s egress addresses accepts as well, and read under Status up to 256 bytes of the text of any answer that is neither 2xx nor a redirect, with its markup removed and the sink’s own secrets masked. The platform’s accounts CS Support and CS Scheduler hold the right without a grant, since they hold every right.
- Open System Preferences > Connectors and Extensions > egos.tech > PXM Log Exporter, or Settings below it, to reach the exporter’s settings. If the settings page opens empty, choose PXM Log Exporter in that page’s own tree. Status, at the top of the exporter’s own page, shows the state of the exporter and its sinks and the module’s version and the commit it was built from, links to this documentation and the release notes, and ends with the purge (see Removing the exporter). Each sink’s page starts with that sink’s state and, while the sink is on and saved, a connection test.
- Choose the event groups and switch on the exporter, then set up a sink:
- Secrets (tokens, keys, client secrets, private CA certificates, client certificates) live in the credential store; the pickers offer “Create new…”. The credential editor asks for a token twice. If a pasted PEM loses its line breaks, the module restores them. A credential that holds a token, a key or a client secret belongs to the first setting that uses it; if you select it for another setting, that sink stops with a message that names the setting it belongs to. Several settings can share a certificate.
- Save, then use Test HTTPS connection on the HTTPS sink page, or Test TLS stream connection on the
TLS stream sink page. Each sends one
exporter.testevent with the saved options and shows the result below its button. When a test cannot reach the receiver, it says only that, so the buttons cannot be used to probe hosts and ports. While the exporter is on, the job tries to deliver with the saved options within about five minutes of a save, and the sink’s status line then shows why the receiver could not be reached.
Certificates and addresses
Endpoints must present a certificate valid for their host name; for a private CA, set its certificate. The Sentinel receiver’s Entra ID sign-in does not use the private CA.
The sinks deliver to public internet addresses only: every address the endpoint’s host resolves to must be public, and the sink connects to those addresses, each in turn until one answers; an IPv4 address in another notation, such as a single hexadecimal number, counts as the address it stands for. The platform can configure an outgoing proxy for a tenant. When the tenant has one and Use the tenant’s outgoing proxy is on, the sinks connect through it with HTTP CONNECT. The proxy resolves the host itself and decides which addresses it reaches; a proxy can refuse loopback, link-local and private addresses. The exporter still refuses a host whose addresses, as the tenant resolves them, are not all public, and on the direct path it connects only to the addresses it checked.
Centric PXM™ is a trademark of Centric Software, Inc.