Skip to content

README.md

Latest commit

 

History

History
67 lines (50 loc) · 4.94 KB

README.md

File metadata and controls

67 lines (50 loc) · 4.94 KB
Raw

Logging Example

In order to run this example, you need to be running a Tenant Security Proxy (TSP) on your machine. Check the README.md file in the parent directory to see how to start the TSP, if you haven't done so yet.

Once the TSP is running, you can experiment with this example Node program. It illustrates the basics of how to use the Tenant Security Client (TSC) SDK to log security events. The example code shows two scenarios:

  • logging a login security event with additional metadata
  • logging an admin create security event with minimal metadata

To run the example, you will need to have Node installed on your computer. Try a node -v to see what version you are using. We tested the example code using v10.22.0 and v12.0.0.

If node is ready to go, execute these commands:

export API_KEY='0WUaXesNgbTAuLwn'
yarn
yarn start

We've assigned an API key for you, but in production you will make your own and edit the TSP configuration with it. This should produce output like:

yarn run v1.22.5
$ yarn tsc --target ES6 --sourceMap false --module CommonJS --outDir ./dist/src src/index.ts && node dist/src/index.js
$ /home/craig/Repos/tenant-security-client-nodejs/examples/logging-example/node_modules/.bin/tsc --target ES6 --sourceMap false --module CommonJS --outDir ./dist/src src/index.ts
Using tenant tenant-gcp-l.
Successfully logged admin add event.
Successfully logged user login event.
Done in 3.80s.

The output "Successfully logged admin add event" is printed after successfully sending the admin add event to the TSP. Same thing with "Successfully logged user login event" but for the login event.

If you look in the TSP logs you should see something like:

tenant-security-proxy-1      | {"contexts":"request","level":"INFO","service":"proxy","timestamp":"2026-05-05T17:44:47.667242Z","message":"Security Event Received","name":"request","ray_id":"pZY_gLl25tys429w","tenant_id":"tenant-gcp-l"}
tenant-security-proxy-1      | {"contexts":"request","level":"INFO","service":"proxy","timestamp":"2026-05-05T17:44:47.667242Z","message":"Security Event Received","name":"request","ray_id":"VeV-jMiKGU4Ie44N","tenant_id":"tenant-gcp-l"}
tenant-security-proxy-1      | {"contexts":"request","level":"INFO","service":"proxy","timestamp":"2026-05-05T17:44:47.667266Z","message":"{\"iclFields\":{\"dataLabel\":\"PII\",\"requestId\":\"Rq8675309\",\"requestingId\":\"userId1\",\"sourceIp\":\"127.0.0.1\",\"objectId\":\"userId1\",\"event\":\"USER_LOGIN\"},\"customFields\":{\"field1\":\"gumby\",\"field2\":\"pokey\"}}","name":"request","ray_id":"pZY_gLl25tys429w","tenant_id":"tenant-gcp-l"}
tenant-security-proxy-1      | {"contexts":"request","level":"INFO","service":"proxy","timestamp":"2026-05-05T17:44:47.667277Z","message":"{\"iclFields\":{\"dataLabel\":null,\"requestId\":null,\"requestingId\":\"adminId1\",\"sourceIp\":null,\"objectId\":\"newAdmin2\",\"event\":\"ADMIN_ADD\"},\"customFields\":{}}","name":"request","ray_id":"VeV-jMiKGU4Ie44N","tenant_id":"tenant-gcp-l"}
tenant-security-logdriver-1  | {"contexts":"main;batching;tenant","level":"INFO","service":"logdriver","timestamp":"2026-05-05T17:44:49.679271094Z","message":"BATCH: 2 log events received for an unknown tenant. Using a stdout logger for this tenant.","name":"tenant","tenant_id":"tenant-gcp-l"}
tenant-security-logdriver-1  | {"contexts":"main;batching;stdout client;write-entries","level":"INFO","service":"logdriver","timestamp":"2026-05-05T17:44:49.679569969Z","message":"{\"tenantId\":\"tenant-gcp-l\",\"timestamp\":\"2026-05-05T17:44:42.656Z\",\"iclFields\":{\"dataLabel\":\"PII\",\"sourceIp\":\"127.0.0.1\",\"objectId\":\"userId1\",\"requestingId\":\"userId1\",\"tspRayId\":\"ray_id\",\"event\":\"USER_LOGIN\",\"requestId\":\"Rq8675309\",\"logdriverRayId\":\"kuQ6xXLf2R20oOHX\"},\"customFields\":{\"field1\":\"gumby\",\"field2\":\"pokey\"}}","name":"write-entries"}
tenant-security-logdriver-1  | {"contexts":"main;batching;stdout client;write-entries","level":"INFO","service":"logdriver","timestamp":"2026-05-05T17:44:49.679677552Z","message":"{\"tenantId\":\"tenant-gcp-l\",\"timestamp\":\"2026-05-05T17:44:47.663Z\",\"iclFields\":{\"event\":\"ADMIN_ADD\",\"tspRayId\":\"ray_id\",\"requestingId\":\"adminId1\",\"logdriverRayId\":\"HmK3yMzAtG510ZNf\",\"objectId\":\"newAdmin2\"},\"customFields\":{}}","name":"write-entries"}

This shows the TSP receiving these events, batching them up together, and sending them successfully to Logdriver. Because this tenant does not have a log sink configured, the security events will be output to Logdriver's stdout logs.

If you would like to experiment with a different tenant, just do:

export TENANT_ID=<selected-tenant-ID>
yarn start

The list of available tenants is listed in the README.md in the parent directory.

Additional Resources

If you would like some more in-depth information, our website features a section of technical documentation about the SaaS Shield product.