Enable Logging

^{New 3.0.14}

Helps you debug, trace and audit all LDAP operations performed by the Nodinite LDAP Web API.

Nodinite is a support and maintenance tool with a Logging feature enabling true end-to-end Logging solution. The LDAP Web API uses the Nodinite Serilog appenders.

This feauture is very handy since all operations can now be logged using the standard logging strategy for Nodinite. Use any of the following Nodinite Serilog appenders to create a JSON-based Log EventJSON Log Event. You should use the Pickup Log Events Service Logging Agent.

Configuration files

To enable Logging, you must perform changes to the following files

• settings.json
• appsettings.json
  • File
  • Blob

Use Notepad++ or some other text editor. Open the file with administrative privileges so you have the right to save it once your typing is complete.

Any Nodinite Serilog sink can be used (any other custom/3rd party sink can be used as well) as long as a supported version of Serilog is in use. We are publishing new versions after every patch tuesday.

We ship the binaries with the following Nodinite Serilog sink

• File (handy for on-premise solutions)
  • Name: Nodinite.Serilog.FileSink
  • Folder: C:\\Temp\\Nodinite\\LDAP
  • Args
    • FileExension: ".json"
• Blob (handy for Azure/cloud solutions)

  • Name: Nodinite.Serilog.AzureBlobStorageSink
    Then, according to the Blob Storage documentation, use any of the following to connect with the container:

  • Connection string (example on this page)

  • System managed identity

  • Named managed identity

In the settings.json file, the following fields determine what to include in the Logging.

Important

Logged events may include sensitive data! Ensure to restrict access to the intermediate storage.

settings.json

{
  "LogRequest": true,
  "LogResponse": true,
  "LogHttpHeaders": true,
  "RunningInAzure": null,
  "Connections": [
    {
      "Id": "f8caa70f-e9eb-4e39-a93f-6c7ee302bdb8",
      "AuthenticationType": 2,
      "DSAServer": "DC01",
      "DSAServerPort": 389,
      "UserName": "DEV\\Administrator",
      "Password": "Password",
      "KeyVaultPassword": null
    }
  ]
}

File Example Settings

Below is an example enabling Logging using the Nodinite File sink Serilog appender.

appsettings.json (file)

{
  "https_port": 443,
  "ProductKey": {
    "CustomerName": "CustomerName",
    "Key": "ProductKey"
  },
  "ConnectionStrings": {
    "appConfiguration": ""
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "Serilog": {
    "Using": [ "Nodinite.Serilog.FileSink" ],
    "WriteTo": [
      {
        "Name": "NodiniteFileSink",
        "Args": {
          "Folder": "C:\\Temp\\Nodinite\\LDAP",
          "Settings": {
            "LogAgentValueId": 503,
            "LogOnlyMessagesWithBody": "false",
            "FileExtension": ".json"
          }
        }
      }
    ]
  },
  "AppConfigEndpoint": "https://devsettings.azconfig.io",
  "AllowedHosts": "*"
}

Blob Storage Example

Below is an example enabling Logging using the Nodinite Blob Storage sink Serilog appender.

appsettings.json (Blob)

{
  "https_port": 443,
  "ProductKey": {
    "CustomerName": "CustomerName",
    "Key": "ProductKey"
  },
  "ConnectionStrings": {
    "appConfiguration": ""
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "Serilog": {
    "Using": [ "Nodinite.Serilog.AzureBlobStorageSink" ],
    "WriteTo": [
      {
        "Name": "NodiniteAzureBlobStorageSinkWithConnectionString",
        "Args": {
          "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=acme;AccountKey=xyz;EndpointSuffix=core.windows.net",
          "ContainerName": "logevents",
          "Settings": {
            "LogAgentValueId": 503,
            "LogOnlyMessagesWithBody": "false",
            "FileExtension": ".json"
          }
        }
      }
    ]
  },
  "AppConfigEndpoint": "https://devsettings.azconfig.io",
  "AllowedHosts": "*"
}