Python package for logging to LogDNA
===
Install
$ pip install logdnaSetup
import logging
from logdna import LogDNAHandler
key = 'YOUR API KEY HERE'
log = logging.getLogger('logdna')
log.setLevel(logging.INFO)
options = {
'hostname': 'pytest'
}
# Defaults to false, when true ensures meta object will be searchable
options['index_meta'] = True
test = LogDNAHandler(key, options)
log.addHandler(test)
log.warn("Warning message", {'app': 'bloop'})
log.info("Info message")Required
Optional
- Hostname - (String) - max length 32 chars
- MAC Address - (String)
- IP Address - (String)
- Max Length - (Boolean) - formatted as options['max_length']
- Index Meta - (Boolean) - formatted as options['index_meta']
Usage
After initial setup, logging is as easy as:
# Simplest use case
log.info('My Sample Log Line')
# Add a custom level
log.info('My Sample Log Line', { 'level': 'MyCustomLevel' })
# Include an App name with this specific log
log.info('My Sample Log Line', { 'level': 'Warn', 'app': 'myAppName'})
# Pass any associated objects along for context
context = {
'foo': 'bar',
'nested': {
'nest1': 'nested text'
}
}
opts = {
'level': 'warn',
'context': context
}
log.info('My Sample Log Line', opts)API
LogDNAHandler(key, [options])
key
Required
Type: String
Values: YourAPIKey
The LogDNA API Key associated with your account.
options
app
Optional
Type: String
Default: ''
Values: YourCustomApp
Max Length: 32
The default app passed along with every log sent through this instance.
hostname
Optional
Type: String
Default: ''
Values: YourCustomHostname
Max Length: 32
The default hostname passed along with every log sent through this instance.
index_meta
Optional
Type: Boolean
Default: False
We allow meta objects to be passed with each line. By default these meta objects will be stringified and will not be searchable, but will be displayed for informational purposes.
If this option is turned to true then meta objects will be parsed and will be searchable up to three levels deep. Any fields deeper than three levels will be stringified and cannot be searched.
WARNING When this option is true, your metadata objects across all types of log messages MUST have consistent types or log entries will be silently dropped!
level
Optional
Type: String
Default: Info
Values: Debug, Trace, Info, Warn, Error, Fatal, YourCustomLevel
Max Length: 32
The default level passed along with every log sent through this instance.
max_length
Optional
Type: Boolean
Default: True
By default the line has a maximum length of 32000 chars, this can be turned off with the value false.
log(line, [options])
line
Required
Type: String
Default: ''
Max Length: 32000
The line which will be sent to the LogDNA system.
options
level
Optional
Type: String
Default: Info
Values: Debug, Trace, Info, Warn, Error, Fatal, YourCustomLevel
Max Length: 32
The level passed along with this log line.
app
Optional
Type: String
Default: ''
Values: YourCustomApp
Max Length: 32
The app passed along with this log line.
context
Optional
Type: JSON
Default: None
A meta object for additional context about the log line that is passed.
index_meta
Optional
Type: Boolean
Default: False
We allow meta objects to be passed with each line. By default these meta objects will be stringified and will not be searchable, but will be displayed for informational purposes.
If this option is turned to true then meta objects will be parsed and will be searchable up to three levels deep. Any fields deeper than three levels will be stringified and cannot be searched.
WARNING When this option is true, your metadata objects across all types of log messages MUST have consistent types or log entries will be silently dropped!
timestamp
Optional
Default: time.time()
A timestamp in ms, must be within one day otherwise it will be dropped and time.time() will be used in its place.
License
MIT © LogDNA
Happy Logging!