- 4 minutes to read

Log API FAQ and Troubleshooting guide

Quickly resolve issues and get the most from your Nodinite Log API with this comprehensive FAQ and troubleshooting guide. Here you'll find solutions to common problems, configuration tips, and best practices for logging business transactions and events.

What you'll find on this page:

✅ Solutions to common Log API errors and configuration issues
✅ Supported protocols and integration options
✅ Guidance for logging business transactions and events
✅ Contact details for expert support

What IIS App Pool settings does the LogAPI require

See IIS Authentication settings for required configuration details.

I'm getting a GRANT EXECUTE Error...

You are most likely missing some SQL access rights. Make sure to review the [Prerequisites][:nodinite: prerequisites for Log API access rights].

Cannot read configuration file due to insufficient permissions

If you encounter a 'Cannot read configuration file due to insufficient permissions', follow the linked guide to resolve file permission issues.

Does the Log API support Swagger?

Yes, the Log API provides Swagger support, including documentation, client SDK generation, and discoverability. Swagger offers a simple yet powerful representation of the RESTful API.
swagger
Swagger example for a Log Event.

What kind of data can I send using the Log API?

You can log any data to the Log API. The primary purpose is logging Business Transactions. With Nodinite, you can provide self-service access to business-critical data with role-based access for your stakeholders. Apply smart filters (restrictions) to avoid potentially sensitive data from messages being revealed. Always log data for a specific business or compliance reason.

  • Event - Generic information about the event (like time, message type name and endpoint) - WHEN, HOW.
    • Payload - The business transaction with data, usually XML, JSON, flatfile like EDI/X12 or zip file - WHAT.
    • Context Properties - Key value based collection of arbitrary data - (for example InvoiceId and CorrelationId) - WHAT.
      • With the powerful Nodinite Context Options, you can control the behaviour of how Nodinite processes events.
graph TD subgraph "Event" subgraph "Details" roED[fal:fa-bolt Event Details
LogDateTime = 2018-05-03 13:37:00+02:00
EndPoint = https://api.nodinite.com/...
MessageType=Invoice
...] end subgraph "Payload" ro[fal:fa-envelope Message
base64EncodedMessage] end subgraph "Context Properties" roKey[fal:fa-key Key Values
InvoiceNo = 123
CorrelationId=456
...] end end

Illustration: Log Event structure with details, payload, and context properties in Nodinite.

Even though Nodinite manages large messages (we have seen at least 5.5 GB payloads in real-world customer environments), the Log API has its limitations due to being an API. If you need large messaging support, contact our support for guidance on how to properly manage your specific use case.

What protocols are supported?

See the Hardening guide for supported protocols and security recommendations.

If the browser returns that the certificate is not secure, the Log API will not work (since it is not operational).
Not a valid cert
Example: Browser warning for an invalid certificate prevents Log API operation.

How can I send events and data to the Log API?

You can write your own code to invoke the Log API. Below are your main options, each detailed individually:

Tip

Other asynchronous options are available, such as posting a Log Event to the filesystem or, even better, to various queues. Use this in combination with the Nodinite Pickup Service to eliminate dependency on Nodinite availability—giving you the freedom to update Nodinite whenever you want.

sequenceDiagram Your Application-XQueue: Create and Send Log Event loop Periodic check and loop While Log Events Exists alt Run Pickup Service->>Queue: Get Log Events from Queue Queue->>Pickup Service: Read Message Pickup Service->>Log API: Send Log Event Log API->>Pickup Service: ACK/NACK (or Exception) Pickup Service->>Queue: Remove Message else Failed Pickup Service->>Queue: Return Message end end

Illustration: Asynchronous event delivery using Pickup Service and queues for robust, decoupled logging.

Which Log Agents use the Log API?

The following Log Agents use the Log API:

Nodinite Log Agents can manage situations where the Log API is unavailable (such as during updates, service windows, or database outages). The Log Agents will resume operation automatically whenever the Log API comes back online and is operational.

Contact our support

If you still have questions or encounter issues with the Log API, don't hesitate to contact us at support@nodinite.com.