Page History

...

Message Logging may be configured to include additional request metadata. The metadata includes information such as sending process information and API request information. The following metadata is available.

tlsversionThe TLS cipherconfig*An item for each of the configuration options for the collector, e.g, config-collector-name, config-collector-pathmon, etc. Also the name of the filter selected, as config-filter-name.

Name	Value
process-name	The process name of the sending process.
process-program-file	The sending process program file name.
process-ancestor-name	The process name of the sending process ancestor.
process-ancestor-program	The program file name of the sending process ancestor.
api-name	The API name.
api-file-name	The API file name.
api-method	The API operation method.
api-path	The API operation path.
api-base-url	The API base url.
api-alias	The API operation alias
config-	The TLS protocol version.	tls-cipher	*	An item for each of the configuration options for the collector, e.g, config-collector-name, config-collector-pathmon, etc. Also the name of the filter selected, as config-filter-name.
net-local-ip	The local IP address of the socket connection.
net-local-port	The local port of the socket connection.
net-remote-ip	The remote IP address of the socket connection.
net-remote-port	The remote port of the socket connection.
net-process	The TCP/IP process in use.
process-	name	The process name of the sending process.
process-program-file	The sending process program file name.
process-ancestor-name	The process name of the sending process ancestor.
process-ancestor-program	The program file name of the sending process ancestor.
tls-version	The TLS protocol version.
tls-cipher	The TLS cipher

Sensitive Data Masking

The Sensitive Data Masking feature allows message fields to be designated as holding sensitive data by adding the attribute "sensitive" : true to the element describing the field. Fields so designated are masked in the Message Log request. The feature can be disable by starting the SERVER process with the --disable-sensitive-data-masking option. For more information see Sensitive Data Masking.

...

During the process of creating or updating a configuration file, the configuration may be validated using the LWSCOM CHECK command.

Code Block

language	text

tacl> run lwScomlwscom
LightWave Server COM 1.1.0 - \NODE.$X123
Copyright (c) 2020 NuWave Technologies, Inc. All rights reserved.
LWSCOM 1-> check config mlogcfg
Checking CONFIG file MLOGCFG.
The file contains a valid 'msg-log' configuration.
The CONFIG file is valid.
LWSCOM 2->

...

Option	Description
enabled	A boolean such as "true" or "false", indicating if the collector is enabled. Disabled collectors may be referenced by filters but messages will not be sent. Required.
type	The type of collector, which must be "serverclass". If omitted, the default value is "serverclass".
pathmon	The process name of the serverclass PATHMON process, which may be specified as a DEFINE. Required if type is "serverclass".
serverclass	The serverclass name. Required if type is "serverclass".
content	A comma separated list of one or more of the following content selectors: api - API metadata net - Network metadata process - Process metadata rq-ipm - The request IPM rq-http - The request HTTP protocol information (request line, headers, etc.) rq-body - The request body rp-ipm - The reply IPM rp-http - The reply HTTP protocol information (request line, headers, etc). rp-body- The reply body tls - TLS metadata user - The user data. all - all possible content. The default value is 'all'. May be negated, see Using Negation.
io-retry-interval	The number of seconds to wait before retrying a failed I/O to the collector target. The value must be in the range 5 - 30 seconds.
io-retry-limit	The number of times to retry a failed I/O to the collector target. The value must be in the range 1 - 10 retries.
io-max-length	The maximum size of any I/O to the collector target. The sending process always tries to use the maximum I/O size possible for the target collector. This parameter may be used to reduce the I/O size to any limit imposed by the target process. Note that this parameter may also be used to artificially limit the I/O size of a Pathsend serverclass collector, in order to test the servers ability to handle streaming requests using Pathway dialogs.
request-code	The IPM request code to use for the message logging request. By default, the the value of LW-ML-RQ-MSG-LOG as the IPM request code. This option may be used to override that value and allow each collector configuration to use a unique request code.

...

Option

Description

alias

A single pattern or a sequence of patterns used to select or ignore an operation alias. See Using Patterns. May be negated, see Using Negation.

Code Block

language	yml
title	Example

filters:
  match-when-alias-starts-with-put:
	match-all:
      alias: "put*"
  match-when-alias-starts-with-post-or-get:
    match-all:
      alias:
        - "post*"
        - "get*"

http-status

A single range or a sequence of ranges used to select or ignore http-status values. See Using Ranges. May be negated, see Using Negation.

Code Block

language	yml
title	Example

filters:
  match-when-in-200-range:
    match-all:
      http-status: "200:299"
  match-when-in-200-range-but-not-222:
    match-all:
      http-status:
        - "200:299"
        - "!222"

method

A comma separated list or pattern used to select or ignore HTTP methods. See Using Patterns. May be negated, see Using Negation.

Code Block

language	yml
title	Example

filters:
  match-when-post-or-put:
    match-all:
      method: "post,put"
  match-when-not-get:
    match-all:
      method: "!get"

path

A single pattern or sequence of patterns used to select or ignore an operation path. See Using Patterns. May be negated, see Using Negation. Note that the path used for matching is the actual path used to invoke the operation, not the path specified in the API definition.

Code Block

language	yml
title	Example

filters:
  match-when-account-request:
    match-all:
      path: "/api/1/account/*"
  match-when-account-or-customer-request:
    match-all:
      path:
        - "/api/v1/account/*"
        - "/api/v1/customer/*"

reply-code

A single range or sequence of ranges used to select or ignore reply-code values. See Using Ranges. May be negated, see Using Negation .

Code Block

language	yml
title	Example

filters:
  match-when-0:
    match-all:
      reply-code: "0"
  match-when-10-20-but-not-15:
    match-all:
      reply-code:
        - "!15"
        - "10:20"

rq-header / rp-header

A collection of HTTP request or response header name value pairs. The name matches the HTTP header name. The value may be a pattern. See Using Patterns. May be negated, see Using Negation.

Boolean true of false may also be specified to match when the header is or is not present.

Code Block

language	yml
title	Example

filters:
  match-when-json-reply:
    match-all:
      rp-header:
        content-type: application/json
        header-1: false  # match if header-1 is not present
        header-2: true   # match if header-2 is present, regardless of value

Anchor
usingpatterns
usingpatterns
Using Patterns

...

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Sensitive Data Masking

Anchor
usingpatterns
usingpatterns
Using Patterns

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

Sensitive Data Masking

AnchorusingpatternsusingpatternsUsing Patterns

Anchor
usingpatterns
usingpatterns
Using Patterns