RESTful API Documentation

Our logging system routes everything through a set of REST-ful API interfaces. This section outlines the interface usedto add logging entries into your application buckets.

Since we are still a new service we do not have wrapper libraries available for all languages. If we do not have a libraryavailable for your programming language you can easily roll your own using these endpoints.

Error Logging

Endpoint: addto.justlog.it/v1/log/{token}/error
Parameters
NameRequiredDescription
MessageYesThe error message
StackNoThe call stack detailing the flow of the error.
DetailsNoAny additional details about the error you want to capture.
UserNoA user marker or identifier which will allow you to correlate errors to users to assist in troubleshooting.
Do Not TrackNoFlag to enable advanced user privacy settings.
Examples
POST https://addto.justlog.it/v1/log/0000000/error
{
message: "Your error message"
stack: "Error stack trace"
details: "Additional error details"
user: 2
}
GET https://addto.justlog.it/v1/log/0000000/error?m=Your+error+message&s=Error+stack+trace&d=Additional+error+details&u=2

Performance Logging

Endpoint: addto.justlog.it/v1/log/{token}/perf
Parameters
NameRequiredDescription
Method NameYesThe name of the method timings are being logged for. This needs to be unique in the system soif you have multiple methods with the same name you should prefix it with something that makes it unique like the class name. Ex: Customer.Save() or Order.Save()
TimingYesHow long the method execution took in milliseconds.
UserNoA user marker or identifier which will allow you to correlate possible performance issues to individual users.
Do Not TrackNoFlag to enable advanced user privacy settings.
Examples
POST https://addto.justlog.it/v1/log/0000000/perf
{
method: "Method Name"
timing: 1000
user: 2
}
GET https://addto.justlog.it/v1/log/0000000/perf?m=Method+name&t=1000&u=2

Event / Action Logging

Endpoint: addto.justlog.it/v1/log/{token}/event
Parameters
NameRequiredDescription
Event NameYesThe name of the event you are tracking. This needs to be unique across events, so if you are logginga common event, such as page load, you need to prefix it with something unique like the page name. Ex: Home.Load or Products.Load
DetailsNoAny additional details you want to capture about the event or action.
UserNoA user marker or identifier which will allow you to correlate events to specific users in your system.
Do Not TrackNoFlag to enable advanced user privacy settings.
Examples
POST https://addto.justlog.it/v1/log/0000000/event
{
name: "Event or Action name"
details: "Some event details"
user: 2
}
GET https://addto.justlog.it/v1/log/0000000/event?n=Event+or+Action+name&d=Some+event+details&u=2

Information Logging

Endpoint: addto.justlog.it/v1/log/{token}/info
Parameters
NameRequiredDescription
MethodYesThe name of the method being traced.
DetailsYesThe message indicating the information you want to log.
UserNoA user marker or identifier which will allow you to correlate the information being logged to specific users.
Do Not TrackNoFlag to enable advanced user privacy settings.
Examples
POST https://addto.justlog.it/v1/log/0000000/info
{
method: "MethodName"
details: "Something notable happened"
user: 2
}
GET https://addto.justlog.it/v1/log/0000000/info?m=MethodName&d=Something+notable+happened&u=2

Application Action Logging

Endpoint: addto.justlog.it/v1/log/{token}/appaction
Parameters
NameRequiredDescription
NameYesThe name of the action.
IntervalYesThe interval of time for the collection. Defaults to 60 seconds.
CountYesThe number of actions which were executed during the interval.
TimestampNoThe starting timestamp of the action interval.
Process IdentifierNoIf multiple processes are executing on a single server you can track the identifier so you can see the actions broken down by process.
Min TimingNoAllows you to track the minimum execution time for the action (in milliseconds)
Max TimingNoTrack the maximum execution time for the action (in milliseconds)
Total TimingNoThe total timing of all the actions logged in this interval. Used to calculate the average over time.
Examples
POST https://addto.justlog.it/v1/log/0000000/appaction
{
method: "MethodName"
name: "Action Executed",
interval : 60,
count : 1000,
timestamp : 1400000000,
processid : "Process1",
mintiming : 1,
maxtiming : 1000,
timing : 2000
}
GET https://addto.justlog.it/v1/log/0000000/appaction?n=action+name&i=60&c=1000&time=1400000000&pid=Process1&min=1&max=1000&timing=2000

Custom Values

In addition to the standard values listed above you can also extend your posts with additional information as necessary. Simply add inanother object property for a POST submission or another query string parameter for a GET drop.

The values you add are stored with the individual item instances and can be later used as additional filter parameters or to give additionalcontext to the stored information.

Examples
POST https://addto.justlog.it/v1/log/0000000/{type}
{
method: "MethodName"
details: "Something notable happened"
user: 2
order_number : "123456"
}
GET https://addto.justlog.it/v1/log/0000000/{type}?m=MethodName&d=Something+notable+happened&u=2&on=123456

Do Not Log

The following values are automatically appended to your submissions so you do not, and should not, add them to your submissions.

  • Timestamp
  • IP Address
  • Location
  • User Agent
  • Language
  • Referrer
close
Sign up to get started