Skip to main content
Ruby

An easy to use Ruby/RoR integration

Yoni Farin avatar
Written by Yoni Farin
Updated over a week ago

Install:

gem install coralogix_logger

General:

You must provide the following four variables when creating a Coralogix logger instance.

Private Key – A unique ID which represents your company, this Id will be sent to your mail once you register to Coralogix.

Application Name – The name of your main application, for example, a company named “SuperData” would probably insert the “SuperData” string parameter or if they want to debug their test environment they might insert the “SuperData– Test”.

SubSystem Name – Your application probably has multiple subsystems, for example, Backend servers, Middleware, Frontend servers etc. in order to help you examine the data you need, inserting the subsystem parameter is vital.

Ruby:

Coralogix SDK
require 'coralogix_logger'
PRIVATE_KEY = "11111111-1111-1111-1111-111111111111"
APP_NAME = "MyTestApp"
SUB_SYSTEM = "BL"

# Configure Coralogix SDK. You need to define it only once per process.
Coralogix::CoralogixLogger.configure(PRIVATE_KEY, APP_NAME, SUB_SYSTEM)

# The common practice is to get an instance of the logger in each class and setting the logger name to the class name.
# logger name will be used as category unless specified otherwise.

logger = Coralogix::CoralogixLogger.get_logger("my class")

# Send "Hello World!" message with severity verbose.
logger.log(Coralogix::Severity::VERBOSE, "Hello World!")

# Additional options

# Severity and message parameters are mandatory. The rest of the parameters are optional.

logger.log(Coralogix::Severity::DEBUG, "Hello World!", category: "my category")

logger.log(Coralogix::Severity::INFO, "Hello World!", category: "my category", className: "my class")

logger.log(Coralogix::Severity::WARNING, "Hello World!", category: "my category", className: "my class", methodName: "my method")

logger.log(Coralogix::Severity::ERROR, "Hello World!", category: "my category", className: "my class", methodName: "my method", threadId: "thread id")

logger.log(Coralogix::Severity::CRITICAL, "Hello World!", className: "my class", methodName: "my method", threadId: "thread id")

#Using severity methods

#Only message is mandatory. The rest of the parameters are optional.

logger.debug("Hello World!")

logger.verbose("Hello World!", className: "my class")

logger.info("Hello World!", className: "my class", methodName: "my method")

logger.warning("Hello World!", className: "my class", methodName: "my method", threadId="thread id")

logger.error("Hello World!", className: "my class", methodName: "my method", threadId="thread id")

logger.critical("Hello World!", category: "my category", className: "my class", methodName: "my method", threadId="thread id")

RoR: 

1. add coralogix logger to your gemfile

gem 'coralogix_logger', '>= 0.0.22'

2. add file coralogix.rb under initilizers, with the following:

require 'coralogix_logger'
PRIVATE_KEY = "your private key"
APP_NAME = "your app name"
SUB_SYSTEM = "your sub system name"

Coralogix::CoralogixLogger.configure(PRIVATE_KEY, APP_NAME, SUB_SYSTEM)
#Coralogix::CoralogixLogger.debug_mode=true
#Coralogix::CoralogixLogger.print_stack_trace = true
#Coralogix::CoralogixLogger.stack_frame = 5
Rails.application.config.coralogix_logger = Coralogix::CoralogixLogger.get_logger("your category")
#coralogix_logger.level = 2


Rails.logger.extend(ActiveSupport::Logger.broadcast(Rails.application.config.coralogix_logger))
Did this answer your question?