Tom Luxsox Coins

Set Log

Logging Best Practices Using Crypto Logger

Logging Best Practices Using Crypto Logger

Logging can be an invaluable tool during all stages of software development right from development to deployment/production, Good use of logging enables you to record and report errors, maintain audit trials, gather app usage statistics and gather performance benchmarks. The following are best practices to be used when using logging in your software:

Know Who Will Consume And Analyze The Logs

Logging output should make sense to the people who will view/Analyze the logs. For example, logging information targeted at developers will typically be quite different from that targeted at end-users which in turn will be different from that targeted at system-administrators. For example, end users are likely to have no use for your logs if you output messages like "Heap error in function ABC" or "Lock cannot be acquired for polling". Generating the correct type of logging info is important so that the log information can actually be used and understood by the consumers of the logs.

Decide Beforehand What Type Of Messages Should Be Used For Each Log Level

Loggers typically provide multiple log levels using which messages can be logged. Each level indicates a different level of severity and/or detail. Typical levels defined are Debug, Info, Warning, Error and Fatal. It is important that all the members of your team agree beforehand on the type of messages to be used with each log level. This is necessary so that a log generated during a routine run of the software does not get flooded with Debug log messages. Similarly, important information which should have the Warning, Error or Fatal levels should not be logged using the Debug or Info levels. Since there are no hard and fast rules for what constitutes the informational detail and/or severity associated with each level, it is upto your team to decide this beforehand.

Crypto Logger provides the following levels and guidelines/conventions for when each level should be used:

Level Description
Debug Used during debugging and development of your software. Specifies the maximum level of detail - a Logger set at Debug level allows all log entries to be written.
Detailed Used when detailed logging info is needed from your software. A Logger set to this level allows only log entries with their levels set to Detailed or higher.
Normal Used during normal operation of your software. A Logger set to this level allows only log entries with their level set to Normal or higher.
Warning Used to limit generated logging information to only warnings or more serious conditions during the operation of your software. A Logger set to this level allows only log entries with their level set to Warning or higher.
Error Used to limit generated logging information to only errors or fatal conditions during the operation of your software. A Logger set to this level allows only log entries with their level set to Error or Fatal.
Fatal Used to limit generated logging information to only fatal conditions during the operation of your software. A Logger set to this level allows only log entries with their level set to Fatal.

Log Only As Much As Needed

Logging code is not free - it increases the size of your code and your compiled binaries. Further, the logging code itself consumes processor time to run. Logging code also requires maintenance just like any other code. Keep these factors in mind when deciding how much and what type of data to log. You should not log the code execution progress after each line of code, nor should you produce useless logs contain very little info like "Failure!". Use your judgment when deciding the quantity and quality of data to log that will provide useful information when it actually comes time to view and Analyze the logs to resolve issues or gather statistics.

Use External Configuration Files

Logging should be configured via an external configuration file so that the log outputs, level, verbosity, etc can be easily configured without having to recompile your software.

Crypto Logger supports simple XML configuration files. It can also watch external configuration files for changes - if the file changes, Crypto Logger will automatically reconfigure itself using the changed file.

Ship Production Apps With Logging Configured To Produce Less Log Information

Typically, you should ship production apps that are configured (via external configuration files) to only output Info, Warning, Error Or Fatal log messages. Only if the software encounters a problem should it be configured (again, via a configuration file) to output Debug level log messages which can help in trouble-shooting the problem.

Use Buffered Mode To Avoid Repeated Costly Writes To Disk, Network, etc

If you output log messages to targets like disks, or tcp, which are costly in terms of write times, considered using the buffered mode of your logging software. When a certain quantity of log data is Buffered, all Buffered log data is written at once which typically saves a considerable amount of time.

Crypto Logger has full support for buffered mode and various triggers which induce flushing.

Use Asynchronous Mode For Performance Critical Code

When logging from performance-critical code, consider using the Asynchronous mode of your logging software. In Asynchronous mode, log data is Buffered and is written on a background thread so that your performance-critical code does not wait for the log data to be written.

Crypto Logger has full support for asynchronous mode.

Prepare Data To Be Logged Only If Logging Is Enabled At The Desired Level

Before formatting or otherwise preparing the data to be logged, check that logging is enabled at the desired level so that time is not wasted in the formatting/preparation of the data.

For example, instead of doing this:

log.MainSession.LogMessage(string.Format("Current time is {0}",DateTime.Now));

use following code:

if(log.MainSession.IsEnabled(LogEntryLevel.Debug))
log.MainSession.LogMessage(string.Format("Current time is {0}",DateTime.Now));

Crypto Logger comes with log method overloads which take all format parameters so that you do not have to check for level and your code remains clean and minimal.

Keep Logging Code Error Free

You should take care that the logging code itself does not cause undesirable effects. The logging code should remain as transparent as possible to the actual execution of the software and should not cause exceptions, errors, deadlocks, slowness or other undesirable effects.

This is the overriding principle that is used in the design of Crypto Logger - logging should not alter the behavior or flow of your software. Any exceptions or errors that occur during logging are handled gracefully and the execution of the host software continues uninterrupted.

Keep Logging Code In Sync With The Software Code

Many times, the code surrounding the logging code changes, but the log messages are not changed or removed or added to reflect the changed code. Such out-of-sync logging code may not be very useful in providing helpful information when the log is viewed or analyzed. So, just like comments, it is important that the log messages and logging code is updated when the software code changes.

About the Author

G Himangi is a Senior Software Developer at LogicNP Software and is a member of LogicNP Software's component and controls development team.
Original article : http://www.ssware.com/articles/logging-best-practices-using-crypto-logger.htm

NPL41 Decorative Log $69.3 Napoleon NPL41 Decorative Log Set

Log Set For Gas Fireplaces $206.1 Create a classic look with this log set and grate. The Log Set for 1224 Crystal Burner will be a great addition to your outdoor fireplace. Log set for Fireplaces with CF-1224 burner. Includes Log Set, Lava Rocks and Grate Made for use with Fireplaces Dimensions: 12"L

ADW600 Aged Driftwood Log Set for $261 Majestic ADW600 Aged Driftwood Log Set for WDV600

ADW500 Aged Driftwood Log Set for $263.7 Majestic ADW500 Aged Driftwood Log Set for WDV500

Log On $8.99 Log On

Fireplace Log Kits - Log And Grate Set 18 Inch $375 Fireplace Log Kits - Log And Grate Set 18 Inch is available from bedbathstore.com for only $283.00. Shop bedbathstore for the best price and quality with Free Shipping.

Fireplace Log Kits - Log And Grate Set 21 Inch $450 Fireplace Log Kits - Log And Grate Set 21 Inch is available from bedbathstore.com for only $375.99. Shop bedbathstore for the best price and quality with Free Shipping.

Ceramic 6-piece Log Set $181.07 This decorative log set is designed to be used in any bio fuel fireplace. This log set allows you to enjoy the beauty of realistic flames in an environmentally friendly way.Set of six (6) logsSize vary from 3.5" tall pinecones to a large 8.7" logProvide long-lasting use for any bio fuel fireplaceEnvironmentally friendlyMade of ceramic fiberDimensions: 15 inches long x 10 inches high x 5 inches wide

The Running Log $5.18 Written by the head coach for Northern California s Team in Training, The Running Log is the perfect place to document the details of your training regime. With space for logging daily and weekly mileage, as well as time, body weight, route, and weather, this log is packed with training tips and will help you set and stay committed to your goals, organize your training program, and calculate your progress.

Log Cabin Movie Set for City Slickers $39.99 Rich Reid Log Cabin Movie Set for City Slickers - Photographic Print

Optional Log Set For Fire Pits $149.95 Optional LOG SET and LAVA Rock for all ROUND Crystal Fire Burner Fire Pits. Fire Pit sold seperately Weight 15lbs

Classic Log Cabin Building Set $21.99 70 pieces + bonus pieces. Log cabin building directions included. Packed in a nostalgic canister.

SCSI Log Pages $60.54 High Quality Content by WIKIPEDIA articles SCSI target devices provide a number of SCSI log pages. These can be interrogated by a Log Sense command and in some cases can be set by a Log Select command. The Log Sense and Log Select commands include a 6bit address field, allowing for 64 possible log pages. There is a standard map of log page addresses below. Note that any given SCSI device type will only support a subset of these log pages. 00h supported log pages 01h buffer overrun/underrun 02h error counter (write) 03h error counter (read) Author: Surhone, Lambert M./ Tennoe, Mariam T./ Henssonow, Susan F. Binding Type: Paperback Number of Pages: 68 Publication Date: 2011/12/15 Language: English Dimensions: 9.02 x 5.98 x 0.16 inches

2-Can Outdoor Log Set $95 -Convert your existing outdoor firepit or fireplace to a Real Flame gel burning fire. -Enjoy an outdoor fire with out smelling like one. - Comes complete with lava rock and lift tool. -Will burn up to two cans of Real Flame gel fuel. -Made from hand-painted cast concrete. -Comes complete with log set and decorative lava rock. -Uses Real Flame 13 Oz. gel fuel, sold separately.

A Log Cabin from the Movie Set of City Slickers $39.99 Rich Reid A Log Cabin from the Movie Set of City Slickers - Photographic Print

The Jaws Log $16.21 Winner of three Oscars(R) and the highest grossing film of its time, "Jaws" was a phenomenon, and this is the only book on how 26-year-old Steven Spielberg transformed Peter Benchley's #1 best-selling novel into the classic film it became. Hired by Spielberg as a screenwriter to work with him on the set while the movie was being made, Carl Gottlieb, an actor and writer, was there throughout the production that starred Roy Scheider, Robert Shaw, and Richard Dreyfuss. After filming was over, with Spielberg's cooperation, Gottlieb chronicled the extraordinary year-long adventure in "The Jaws Log," which was first published in 1975, generating 17 printings and selling more than 2 million copies. This new edition includes a photo section, a new introduction by Benchley, and a lengthy afterword by Gottlieb that updates the people and events involved in the film, ultimately providing a singular portrait of a famous movie and inspired moviemaking in process.

GVFL30P 30 Vent Free Gas Log Set Remote Ready Propane $697.5 Napoleon GVFL30 30 Vent Free Gas Log Set Remote Ready

GVFL30N 30 Vent Free Gas Log Set Remote Ready Natural $697.5 Napoleon GVFL30 30 Vent Free Gas Log Set Remote Ready

GVFL24P 24 Vent Free Gas Log Set Remote Ready Propane $594 Napoleon GVFL24 24 Vent Free Gas Log Set Remote Ready

GVFL24N 24 Vent Free Gas Log Set Remote Ready Natural $594 Napoleon GVFL24 24 Vent Free Gas Log Set Remote Ready

GVFL18P 18 Vent Free Gas Log Set Remote Ready Propane $549 Napoleon GVFL18 18 Vent Free Gas Log Set Remote Ready

GVFL18N 18 Vent Free Gas Log Set Remote Ready Natural $549 Napoleon GVFL18 18 Vent Free Gas Log Set Remote Ready

Log And Grate Set for Indoor Fireplace - 24 Inch $520 Log And Grate Set for Indoor Fireplace - 24 Inch is available from bedbathstore.com for only $379.99. Shop bedbathstore for the best price and quality with Free Shipping.

Resin Tealight Fireplace Log $116 The rustic charm of a flickering fire is recreated with this clever, handcrafted resin log sculpture. Set right in the fireplace for a no fuss alternative to lighting. Holds 11 tea lights which are included.

Gnome Lying on Log Statuary $35.95 Gnome Lying on Log Statuary Every Garden Needs a Gnome This lovely hand made statuary will adorn any indoor or outdoor environment and is perfect for the garden or landscaping. This piece is sure to bring the spirit of adventure to your garden. Made of weather resistant cast-stone resin, this gnome is bound to enchant all who set foot in your garden or yard. Surprise and delight visitors to your garden with this friendly Gnome Lying on Log Statuary. Measures 10" Long x 4.5" Wide x 19" High. Ships Quickly!

Uniflame W1246 BLACK LOG KINDLING RACK WITH FIRETOOLS $140.14 The Black Log Kindling Rack gives a classy look to your hearth and is also a perfect log holder for your load of wood. Set includes the log holder shovel tongs poker and a natural fiber brush. Black Log Kindling Rack with Firetools 31 High X 16 Wide

18-Inch Convert-to-Gel Log Set-Birch $228 -Convert your existing gas or wood-burning fireplace into a Real Flame gel-fueled fireplace and never worry about hauling wood, messy ashes, or soot again! -The six-piece realistic log set holds up to three cans of Real Flame� gel fuel. -Lift assembly allows for easy access to place and remove cans. -Includes wrought iron grate and lava rocks. -This log set does not need venting, there is no need to open the flue, and it can be used in dormant fireplaces. -Fits most existing wood burning fireplaces. -Made from hand painted cast concrete and steel. -Comes complete with 5 piece log set, grate, and decorative lava rock.

HPC 6 Piece Outdoor Woodland Log Set $292.31 HPC outdoor 6 piece Woodland log set is perfect for a 24 inch fire pit. 2 Logs are 19 1/2 inch in length and 4 logs are 15 1/2 inch length.

Firegear 21-Inch Advantage Vented Log Set Without Burner $207 A realistic gas log set that would make mother nature jealous, the 21-inch Advantage gas log set by Firegear features specially blended refractory materials promise years of enjoyment, and steel inserts help to reinforce each log. Air dried and hand painted, these gas logs provide the missing element in your fireplace.

Firegear 24-Inch Advantage Vented Log Set Without Burner $295.2 A realistic gas log set that would make mother nature jealous, the 24-inch Advantage gas log set by Firegear features specially blended refractory materials promise years of enjoyment, and steel inserts help to reinforce each log. Air dried and hand painted, these gas logs provide the missing element in your fireplace.

Firegear 30-Inch Advantage Vented Log Set Without Burner $494.1 A realistic gas log set that would make mother nature jealous, the 30-inch Advantage gas log set by Firegear features specially blended refractory materials promise years of enjoyment, and steel inserts help to reinforce each log. Air dried and hand painted, these gas logs provide the missing element in your fireplace.

GloFire GFP18 Providence Log Set Complete $163.8 This set is the perfect entrylevel set for DIY and contractor sales all required parts are in one shippingfriendly kit. This set is reversible to change from a full log to a splitoak appearance. Exacting detail from all viewing angles. Natural looking log ends no convex or concave ends instead saw cut reality. Deep bark texture detailed wood grain areas.

6br - Grandview Lakeside Log Lodge $463 For the perfect getaway, our deluxe log lakeside Lodge is just what you need. Beautifully decorated with many antiques and handmade quilts create the perfect atmosphere to make your stay delightful. Grandview Lakeside Log Lodge is set among towering...

DF1020ARU Electric Log Basket for Existing $199 Flame effect Operates with or without heat Plugs into any 120 volt 3-prong electrical outlet Energy efficient ALL LED Technology Rolling pulsating realistic log set ember bed and flame effects Glowing log and ember bed looks realistic on or off 1350 ...

Firegear 26-Inch CD Vent Free Log Set Without Burner $131.4 Setting the footprint for the vent free gas log market, the 26-inch CD gas log set by Firegear is a promising best seller. Specially blended refractory materials promise years of enjoyment, and steel inserts help to reinforce each log. Air dried and hand painted, these gas logs provide the missing element in your fireplace.

Firegear 29-Inch CD Vent Free Log Set Without Burner $147.6 Setting the footprint for the vent free gas log market, the 29-inch CD gas log set by Firegear is a promising best seller. Specially blended refractory materials promise years of enjoyment, and steel inserts help to reinforce each log. Air dried and hand painted, these gas logs provide the missing element in your fireplace.

Firegear 26-Inch Roaring Red Vent Free Log Set Without Burner $169.2 Designed for the Revolution burner system, this 26-inch gas log set raises the bar for gas log technology. Specially blended refractory materials promise years of enjoyment, and steel inserts help to reinforce each log. Air dried and hand painted, these gas logs provide the missing element in your fireplace.

Firegear 29-Inch Roaring Red Vent Free Log Set Without Burner $188.1 Designed for the Revolution burner system, this 29-inch gas log set raises the bar for gas log technology. Specially blended refractory materials promise years of enjoyment, and steel inserts help to reinforce each log. Air dried and hand painted, these gas logs provide the missing element in your fireplace.

The Faith Log $11.97 "What is faith? Where does faith come from? How does faith work? Faith is not the ability to believe anything and everything. It is not about positive thinking, will-power, or what you see or feel. Biblical faith is much more powerful and precise: Faith is believing what God has said. In this book you will discover the dynamics of faith, including: * What is the essence of faith * How God uses faith * How faith can work for anyone * The importance of love to the working of faith * The importance of God's Word in your mouth * How faith perseveres and develops expectation * How to forgive by faith * How to conquer worry and fear * The gateway between heaven and earth * Why God created us to speak * How to get more revelation of Jesus * The authority we have in the name of Jesus * How to tap into the limitless thoughts of God. These are "jumpstarts" for your faith-defibrillations to set your heart beating with the rhythms of God."

EYF24-R 24 Mountain Oak 5-Piece Refractory Multi-Log $110.7 Majestic EYF24-R 24 Mountain Oak 5-Piece Refractory Multi-Log Set