Log

Monitoring and Managing System Activity

The 'Log' section in the Babel Licensing API is a vital component for overseeing and managing the system's operational data. This section provides functionalities to query log entries within the Babel Licensing Database, making it an indispensable tool for monitoring system activities and maintaining data integrity.

Key Functions and Importance of the Log Section:

1. Monitoring License Transactions: The Log captures all license transactions made by client applications. This includes requests for license checks, activations, floating license requests, and any other licensing-related interactions. By analyzing these log entries, administrators can gain valuable insights into licensing usage patterns, detect any anomalies, and ensure compliance with licensing terms.

2. Tracking Management API Calls: In addition to licensing transactions, the Log also records calls made to management API endpoints. This includes operations like creating, updating, or deleting API keys, customers, products, and licenses. This feature is crucial for auditing changes made to the system and understanding the administrative actions performed over time.

Get

Roles: Administrator, LicenseManager, Sales

The GET method in the Log section is designed to retrieve log entries from the Babel Licensing Database. This function allows users to access detailed records of all activities and transactions within the system. It's an essential tool for system administrators and auditors to monitor licensing transactions by client applications, as well as management operations performed through the API.

Retrieves the log.

GET/v1/log

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

logEntriesarray of LogEntry (object)

log_entries is the list of log entries.

totalLogEntriesCountinteger (int32)

total_log_entries_count is the total number of log entries.

Request

JavaScriptCurl

const response = await fetch('/v1/log', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "logEntries": [
    {
      "message": "text",
      "messageTemplate": "text",
      "level": "text",
      "timeStamp": "text",
      "exception": "text",
      "properties": "text"
    }
  ]
}

Examples

C#

using System.Net.Http;
using Babel.Licensing.Service.Management;

using var httpClient = CreateHttpClient();
var get = new GetLogRequest();

get.Filter = "Level=\"Warning\"";
get.StartDate = DateTime.Now.Subtract(TimeSpan.FromDays(1)).ToTimestamp();

var httpMessage = MakeApiRequest(get, HttpMethod.Get, "/v1/logs");

var result = await httpClient.SendAsync(httpMessage);
var getResponse = await ParseResponseAsync<GetLogResponse>(result);

VB.NET

Imports System.Net.Http
Imports Babel.Licensing.Service.Management

Using httpClient As HttpClient = CreateHttpClient()
    Dim get As New GetLogRequest()

    get.Filter = "Level=""Warning"""
    get.StartDate = DateTime.Now.Subtract(TimeSpan.FromDays(1)).ToTimestamp()

    Dim httpMessage As HttpRequestMessage = MakeApiRequest(get, HttpMethod.Get, "/v1/logs")

    Dim result As HttpResponseMessage = Await httpClient.SendAsync(httpMessage)
    Dim getResponse As GetLogResponse = Await ParseResponseAsync(Of GetLogResponse)(result)
End Using

Shell

curl -X 'GET' \
  'https://localhost:5455/v1/log?filter=Level%3D%22Warning%22&startDate=2024-01-05T12%3A00%3A00.000Z' \
  -H 'accept: application/json' \
  -H 'x-api-key: ApiKey'

Delete

Roles: Administrator

The DELETE method in the Log section enables the removal of specific log entries from the Babel Licensing Database. This functionality is crucial for maintaining the log’s relevance and manageability, allowing administrators to clear outdated or unnecessary data.

Deletes the log.

DELETE/v1/log

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

deletedLogCountinteger (int32)

deleted_log_count is the number of deleted log entries.

Request

JavaScriptCurl

const response = await fetch('/v1/log', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

To completely reset the log set deleteAll to true in the DeleteLogRequest

var delete = new DeleteLogRequest();
delete.DeleteAll = true;

Shell

curl -X 'DELETE' \
  'https://localhost:5455/v1/log?deleteAll=true' \
  -H 'accept: application/json' \
  -H 'x-api-key: ApiKey'