--- title: "HTTP Output" description: "write TenXObject and template values to a log4j2 HTTP socket appender" source: "https://github.com/log-10x/modules/tree/main/pipelines/run/modules/output/event/http/module.yaml" icon: "material/web" --- Defines an HTTP output to write [TenXObject](https://doc.log10x.com/api/js/#TenXObject "Provide structured, reflective access to log/trace events read from input(s).") instance and template field values. ## :material-wrench-outline: Config Files To configure the HTTP output module, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files. Below is the default configuration from: [http/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/run/output/event/http/config.yaml "http/config.yaml"){target="\_blank"} (** Required Fields*).
Edit Online
Edit config.yaml Locally
```yaml # 🔟❎ 'run' HTTP log4j2 output configuration # Configure HTTP outputs to write TenXObject instance and template values. # To learn more see https://doc.log10x.com/run/output/event/http/ # Set the 10x pipeline to 'run' tenx: run # =============================== Dependencies ================================ include: run/modules/output/event/http # ============================== HTTP Options ================================= # Multiple HTTP outputs can be defined below outputHttp: # ----------------------------- Object Output ------------------------------ # 'writeObjects' controls whether to write TenXObject field values to output. - writeObjects: false # (❗ REQUIRED) # ---------------------------- HTTP Options ----------------------------- # 'url' sets the target HTTP host to write TenXObject instance/template values. # For example, the URL below posts to the Datadog log intake endpoint: # https://http-intake.logs.datadoghq.com/v1/input?host=myHost&ddsource=tenx&service=loggingApp&ddtags=env:Dev url: http://127.0.0.1:8000 # 'headers' are added to each HTTP request. For example, # 'DD-API-KEY=TenXEnv.get("apiKey"),DD-APPLICATION-KEY=TenXEnv.get("appKey") # can be used to authenticate the Datadog intake example above. headers: [ Content-Type=application/json ] #'method' sets the HTTP method to use (e.g. GET, POST, DELETE) method: POST # --------------------------- Encoding Options ---------------------------- # 'filter' sets a JavaScript expression that TenXObjects must evaluate as truthy to write to the output. # To learn more see https://doc.log10x.com/run/output/receive/#filter-expressions filter: isObject # 'fields' defines the fields to write for each TenXObject sent to this output. # To learn more see https://doc.log10x.com/run/output/stream/#outputfields fields: - encode() # 'encodeType' specifies how 'fields' are encoded to output. Possible values: [json,delimited]. # To learn more see https://doc.log10x.com/run/output/event/outputStream/#outputstreamencodetype encodeType: json # ---------------------------- Template Output ---------------------------- # The HTTP output below writes new template of TenXObjects written to http url. # To learn more about TenXTemplates, see https://doc.log10x.com/run/template # ---------------------------General Options ----------------------------- # 'writeTemplates' controls whether to write new templates to this output. - writeTemplates: false # (❗ REQUIRED) # ---------------------------- HTTP Options ------------------------------- url: http://127.0.0.1:8000 # 'headers' are added to each HTTP request the output makes. headers: [ Content-Type=application/json ] #'method' sets the HTTP method to use (e.g. GET, POST, DELETE) method: POST ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") multiple HTTP output: |Name|Description| |---|---| |[outputHttpUrl](#outputhttpurl "host HTTP/HTTPS address to connect and write to")|Host HTTP/HTTPS address to connect and write to| |[outputHttpHeaders](#outputhttpheaders "request HTTP header pairs")|Request HTTP header pairs| |[outputHttpMethod](#outputhttpmethod "HTTP request method")|HTTP request method| |[outputHttpFields](#outputhttpfields "list of TenXObject field names to encode")|List of TenXObject field names to encode| |[outputHttpFilter](#outputhttpfilter "a JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output")|A JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output| |[outputHttpWriteObjects](#outputhttpwriteobjects "if true, encode TenXObjects [outputHttpFields](https://doc.log10x.com/run/output/event/http/#outputhttpfields) to this output")|If true, encode TenXObjects \[outputHttpFields\](https://doc.log10x.com/run/output/event/http/#outputhttpfields) to this output| |[outputHttpWriteTemplates](#outputhttpwritetemplates "if true, write new TenXTemplates to this output")|If true, write new TenXTemplates to this output| |[outputHttpEncodeType](#outputhttpencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]")|The output format in which to encode TenXObject values. Possible values:\[json, delimited\]| |[outputHttpEncodedLinePrefix](#outputhttpencodedlineprefix "the line prefix prepended to the encoded event if 'outputHttpEncodeType' is 'delimited'")|The line prefix prepended to the encoded event if 'outputHttpEncodeType' is 'delimited'| |[outputHttpEncodeDelimiter](#outputhttpencodedelimiter "the delimiter placed between key and values pairs if 'outputHttpEncodeType' is 'delimited'")|The delimiter placed between key and values pairs if 'outputHttpEncodeType' is 'delimited'| ### :material-menu-right-outline:**`outputHttpUrl`** Host HTTP/HTTPS address to connect and write to. |Type|Required| |---|---| |String|✔| Specifies an HTTP/HTTPS address to transmit TenXObject instance/template field values. ### :material-menu-right-outline:**`outputHttpHeaders`** Request HTTP header pairs. |Type|Default| |---|---| |List|\[\]| Specifies a list of HTTP header values to accompany requests in the form of = (e.g., header1=hello). ### :material-menu-right-outline:**`outputHttpMethod`** HTTP request method. |Type|Default| |---|---| |String|POST| HTTP method to use (e.g., GET, POST, DELETE). ### :material-menu-right-outline:**`outputHttpFields`** List of TenXObject field names to encode. |Type|Default| |---|---| |List|\[\]| Specifies a list of TenXObject intrinsic/calculated/extracted field names to extract and write to the output. ### :material-menu-right-outline:**`outputHttpFilter`** A JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output. |Type|Default| |---|---| |String|""| Specifies a JavaScript expression that an TenXObject must evaluate as truthy to write its field/template field values to this output. For example, 'outputHttpFilter: this.timestamp' will only emit [timestamped](https://doc.log10x.com/api/js/#TenXBaseObject+timestamped "Return true if length of timestamp is greater than 0") TenXObjects. ### :material-menu-right-outline:**`outputHttpWriteObjects`** If true, encode TenXObjects \[outputHttpFields\](https://doc.log10x.com/run/output/event/http/#outputhttpfields) to this output. |Type|Default| |---|---| |String|true| Determine whether to write [outputHttpFields](https://doc.log10x.com/run/output/event/http/#outputhttpfields "list of TenXObject field names to encode") values of an TenXObject passed to this output. This configuration is typically defined using a JavaScript expression. To enable/disable the output depending on whether a launch argument, environment variable, or JVM -D option evaluates as truthy, use: ```yaml outputHttpWriteObjects: $=TenXEnv.get("myHttpAddress") ``` To learn more see [TenXEnv.get](https://doc.log10x.com/api/js/#TenXEnv.get). ### :material-menu-right-outline:**`outputHttpWriteTemplates`** If true, write new TenXTemplates to this output. |Type|Default| |---|---| |String|false| Controls whether to write template values of TenXObjects passed to this output. The output will only emit TenXTemplates that the pipeline did not load at startup via the [templateFile](https://doc.log10x.com/run/template/#templatefiles "input files or glob patterns containing JSON-encoded TenXTemplates") argument, and will only emit an TenXTemplate once based on its[templateHash](https://doc.log10x.com/api/js/#TenXBaseObject+templateHash "An alphanumeric encoded value of a 64bit hash of the current object's template field.") value. ### :material-menu-right-outline:**`outputHttpEncodeType`** The output format in which to encode TenXObject values. Possible values:\[json, delimited\]. |Type|Default| |---|---| |String|delimited| Specifies how to encode [outputHttpFields](https://doc.log10x.com/run/output/event/http/#outputhttpfields "list of TenXObject field names to encode") values to this output. Possible values: - **json**: formats names and values for the current TenXObject as: {"field":"str","field2":1, "field3": true} - **delimited**: formats values for the current TenXObject as: "str",1,true The [outputHttpEncodeDelimiter](https://doc.log10x.com/run/output/event/http/#outputhttpencodedelimiter "the delimiter placed between key and values pairs if 'outputHttpEncodeType' is 'delimited'") argument determines the separator to use. ### :material-menu-right-outline:**`outputHttpEncodedLinePrefix`** The line prefix prepended to the encoded event if 'outputHttpEncodeType' is 'delimited'. |Type|Default| |---|---| |String|| Sets the char which is prepended to the emitted TenXObject field values when [outputHttpEncodeType](https://doc.log10x.com/run/output/event/http/#outputhttpencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]") is `delimited`. ### :material-menu-right-outline:**`outputHttpEncodeDelimiter`** The delimiter placed between key and values pairs if 'outputHttpEncodeType' is 'delimited'. |Type|Default| |---|---| |String| | Sets the char delimiter to separate TenXObject field values when [outputHttpEncodeType](https://doc.log10x.com/run/output/event/http/#outputhttpencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]") is `delimited`.
:material-github: This module is defined in [http/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/run/modules/output/event/http/module.yaml "http/module.yaml"){target="\_blank"}.