Class CommunicationLogOptions

The options to be used by a HttpRestServiceClient.

Inheritance

System.Object

CommunicationLogOptions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: StoneCo.Framework.Log.Options

Assembly: cs.temp.dll.dll

Syntax

public class CommunicationLogOptions

Examples

Representation on appsettings.json file.

{
  "Host": {
    "ApplicationHost": "http://localhost/",
    "ApplicationName": "Name of Application"
  },
  "Logs": {
    "Communication": {
      "Enable": true,
      "EnableRequestBody": true,
      "EnableResponseBody": true,
      "Host": "https://domain-of-api-log.com/",
      "Uri": "v1/log",
      "Tags": [ "Foo", "Connector", "ServiceClient" ],
      "SensitiveProperties": [ "password" ],
      "ExcludeUri": [ "api/foo" ],
      "ExcludeUriRequestBody": [ "api/foo" ],
      "ExcludeUriResponseBody": [ "api/foo" ]
    }
  }
}

Properties

Enable

Set to use communication log or not.

Declaration

public bool Enable { get; set; }

Property Value

Type	Description
System.Boolean	True to enable, otherwise, false.

EnableRequestBody

Set to use request body on log or not.

Declaration

public bool EnableRequestBody { get; set; }

Property Value

Type	Description
System.Boolean	True to enable, otherwise, false.

EnableResponseBody

Set to use response body on log or not.

Declaration

public bool EnableResponseBody { get; set; }

Property Value

Type	Description
System.Boolean	True to enable, otherwise, false.

ExcludeUri

URIs to be exclude of the log.

Declaration

public string[] ExcludeUri { get; set; }

Property Value

Type	Description
System.String[]	api/foo/new, api/bar/all, ...

ExcludeUriRequestBody

URIs to be exclude the request body on log.

Declaration

public string[] ExcludeUriRequestBody { get; set; }

Property Value

Type	Description
System.String[]	api/foo/new, api/bar/all, ...

ExcludeUriResponseBody

URIs to be exclude the response body on log.

Declaration

public string[] ExcludeUriResponseBody { get; set; }

Property Value

Type	Description
System.String[]	api/foo/new, api/bar/all, ...

Host

The URL that identify host of the log.

Declaration

public string Host { get; set; }

Property Value

Type	Description
System.String	https://domain-of-api-log.com/

SensitiveProperties

Properties that should be masked.

Declaration

public string[] SensitiveProperties { get; set; }

Property Value

Type	Description
System.String[]	cvv, pin, password, token, ...

Type	Description
System.String[]	Service, ServiceClient, CommunicationLog

Uri

URI that identify the resource to registry new entry in log.

Declaration

public string Uri { get; set; }

Property Value

Type	Description
System.String	v1/log