Logging and Monitoring

Operational monitoring of a software application is one of the activities the ensures a successful public launch. Too often it seems like a service’s course to public availability looks something like, Conceptualization → Development → … → SHIP IT. The “…” component is an important step at large enterprises with large public services (like Expedia, Amazon.com, etc) and involves developing a way to monitor an application whilst running it. At smaller organizations though I have seen this smaller step get discarded or not looked at. Today’s post offers a few thoughts on what logging and monitoring looks like today.

Why

In order to keep this discussion to a reasonable length we’ll consider only public facing service applications such as web APIs, public websites, public web applications. Monitoring and management of deployed desktop applications is a different, and more difficult field due to operators having less control over the application’s runtime environment. Even when focusing on a certain class of applications we run into a variety of different ways for an application to be run. One option is that a company uses a language with a runtime virtual machine like Java on the Java Virtual Machine.

Application VM Deployment

An application might be run in the Java Virtual Machine.

In this scenario failures could occur at the server level, the virtual machine, or the application itself. Another alternative that has become more popular recently is using lightweight virtualized containers.

Lieghtweight application VM

An application may be run inside of containerization system like Docker or Rocket.

A physical server might have several containers running on it, each of which could contain applications. In both of these prior pictures it is also possible for the “Server” itself be a virtualized with operating system level virtualization. For example, running a Docker container on AWS EC2 imparts several layers of abstraction between an application and the physical hardware.

It is worth mentioning all of these layers when discussing logging and monitoring because they are all also layers were failures may occur. A customer using an application doesn’t care that an outage was caused by EC2, a bad container update, or an application failure, he or she cares that they couldn’t access the application. The aim of implementing logging and monitoring is to know what failed, where the failure occurred, and when it occurred (preferably as soon as possible after the failure occurs).

What

Logging is one component of a strategy, part of  an answer, and not an end solution. What exactly needs to be monitored will depend on the specifics of an application’s runtime environment. There are, however, some broad categories that should always be addressed when considering monitoring:

  • The application itself
    • Is it running
    • Are there exceptions or errors occurring within the application
    • How long does it take the application to respond to input
  • The application’s local environment
    • Are there multiple instances of the same application running, are all possible instances running
    • Is there free memory
    • What is the system load while the application is running
  • The application’s network environment
    • Is all network traffic reaching the application
    • Is there too much or malicious traffic reaching the application
    • Are there intermediaries between the application and its consumers (e.g. load balancers), if so, are they running
    • Are the application’s networked dependencies (e.g. other services) alive and available

The point of this exercise is to walk the chain of possible failures from the application itself out to the environment of the application. Application level logging that developers add only addresses a couple of the above points and we need additional tools to monitor the other items.

How

The how question with regard to monitoring and logging is deceptively difficult to answer because of the large number tools available today. Again, specific prescriptions here are impossible without specific knowledge of the application and its runtime environment. But, also, again there are useful concepts to discuss with regard to the above ‘What’ points:

Application Logging

I have recently become a fan of elements of the 12 Factor Application list, in particular, the logging factor has resonated well with me. The list is worth reading in whole, but the salient point for logging is that the application writes to STDOUT or equivalent and that an external log router captures that information and sends it elsewhere for processing. Alongside the 12 Factor logging idea, it’s useful to have a concept of centralized log management in an application’s run time environment. Tools like Logentries, Splunk, and Loggly (in no particular order) help to centrally index and search log streams sent from applications, routers, operating systems, etc.

Sending logs from applications to a central logging system where operations personnel can view them is part of the solution. Applications need to also log useful information. This can be a subject of person taste, but my strategy is to log generously—it is very easy to shift through vast quantities of logs using a central logging solution and there is less concern about filling up application server file systems when streaming logs to STDOUT. The following is an example of things that I might log on a request round trip in a service application.

Example logs for a HTTP request

The advantage of generous logging is that it makes it easier to pinpoint an application failure. The key takeaways here are to use some sort of centralized logging solution to capture logs from components throughout the system, make those logs easily searchable, and don’t keep logs on the application servers themselves.

Application’s Local Environment

The application’s local environment encompasses information from  the operating system’s performance statistics to information about the performance of the application in the context of the host. In some ways the monitoring here boils down to determining if an application has the required resources (memory, disk, network bandwidth, etc) to operate optimally for a given load. In the past this type of monitoring might have been handled by command line scripts in POSIX like environments or custom agents utilizing Windows’ WMI to access performance information. More recently, complete agent based solutions like NewRelic and AppDyanmics gather data from both the environment and instrument the application as well. The key takeaway here is have a way to centrally monitor things like network, memory, disk, and CPU utilization. Knowledge of how an application consumes resources can be a first step in identifying whether an application needs to be tuned, scaled, or both in response to customer demands.

Application’s Network Environment

Logging and monitoring in the network environment is a combination of the prior techniques and, again, will depend on the specifics of the application and environment. The goal is to have an understanding of how network traffic from an application’s consumers reach the application. An example of this kind of monitoring is keeping track of requests passing through a load balancer on their way to the application. Another type of logging in the network environment is keep track of requests from the application to its dependencies (other network services).

Application's network environment

Achieving logging on both sides of the application will involve a combination of sending logs from systems running load balancers and agents tools like Nagios that can monitor appliances like routers and intrusion detection devices.


I hope this discussion was useful. Drop me a comment below if there are areas that could use more or less detail or just want to tell me anything in particular.

Share