Skip to main content

Logging to Graphite monitoring tool from java

We use Graphite as a tool for monitoring some stats and watch trends. A requirement is to monitor impact of new releases as build is deployed to app nodes to see if things like
1) Has the memcache usage increased.
2) Has the no of Java exceptions went up.
3) Is the app using more tomcat threads.
Here is a screenshot

We changed the installer to log a deploy event when a new build is deployed. I wrote a simple spring bean to log graphite events using java. Logging to graphite is easy, all you need to do is open a socket and send lines of events.


import org.slf4j.Logger;
import org.slf4j.LoggerFactory; 
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.net.Socket;
import java.util.HashMap;
import java.util.Map;


public class GraphiteLogger {
private static final Logger logger = LoggerFactory.getLogger(GraphiteLogger.class);
 private String graphiteHost;

 private int graphitePort;

 public String getGraphiteHost() {
  return graphiteHost;
 }

 public void setGraphiteHost(String graphiteHost) {
  this.graphiteHost = graphiteHost;
 }

 public int getGraphitePort() {
  return graphitePort;
 }

 public void setGraphitePort(int graphitePort) {
  this.graphitePort = graphitePort;
 }

 public void logToGraphite(String key, long value) {
  Map stats = new HashMap();
  stats.put(key, value);
  logToGraphite(stats);
 }
 
 public void logToGraphite(Map stats) {
  if (stats.isEmpty()) {
   return;
  }

  try {
   String nodeIdentifier = java.net.InetAddress.getLocalHost().getHostName();
   logToGraphite(nodeIdentifier, stats);
  } catch (Throwable t) {
   logger.warn("Can't log to graphite", t);
  }
 }

 private void logToGraphite(String nodeIdentifier, Map stats) throws Exception {
  Long curTimeInSec = System.currentTimeMillis() / 1000;
  StringBuffer lines = new StringBuffer();
  for (Map.Entry entry : stats.entrySet()) {
   String key = nodeIdentifier + "." + entry.getKey();
   lines.append(key).append(" ").append(entry.getValue()).append(" ").append(curTimeInSec).append("\n"); //even the last line in graphite 
  }
  logToGraphite(lines);
 }

 private void logToGraphite(StringBuffer lines) throws Exception {
  String msg = lines.toString();
  logger.info("Writing [{}] to graphite", msg);
  Socket socket = new Socket(graphiteHost, graphitePort);
  try {
   Writer writer = new OutputStreamWriter(socket.getOutputStream());
   writer.write(msg);
   writer.flush();
   writer.close();
  } finally {
   socket.close();
  }
 }

 public static void main(String[]args) throws Exception {
  String host = args[0];
  int port = Integer.parseInt(args[1]);
  String nodeIdentifier ="tomcat.UI.planck_8080";
  Map stats = new HashMap();
  stats.put("memcache_calls", 900L);
  stats.put("num_threads", 50L);
  GraphiteLogger graphiteLogger = new GraphiteLogger();
  graphiteLogger.setGraphiteHost(host);
  graphiteLogger.setGraphitePort(port);
  graphiteLogger.logToGraphite(nodeIdentifier, stats);
 }
}


Comments

  1. Nice article , you have indeed covered topic in details with code examples and explanation. I have also blogged some of my experience as 10 tips on logging in Java

    Thanks
    Javin
    10 tips on logging in Java

    ReplyDelete
  2. How do you create the vertical line for deploys?

    ReplyDelete
  3. It is a super article. and im getting some error in line
    #53 for (Map.Entry entry : stats.entrySet()) with stats.entrySet()
    #62 logger.info("Writing [{}] to graphite", msg); with logger.info
    please give some idea to fix this :)

    ReplyDelete
    Replies
    1. this code was just for a sample, I think I used slf4j wrapper that uses {} syntax. please change the code to use

      logger.info("Writing ["+msg +"] to graphite");

      and it should work fine.

      Delete
  4. That seems to have fixed the issue for the logger but I am also still getting the same issue Dhanushanth was getting on Line #53

    "
    Multiple markers at this line
    Map.Entry is a raw type. References to generic type Map.Entry should be parameterized
    Type mismatch: cannot convert from element type Object to Map.Entry
    "


    ReplyDelete
  5. I updated the imports (sorry I was using a different logger and I wanted to make the code simple). Anyways I converted the code to use slf4j so try now. or you can switch it to use your logger and replace the loging code or remove it.

    ReplyDelete

Post a Comment

Popular posts from this blog

Killing a particular Tomcat thread

Update: This JSP does not work on a thread that is inside some native code.  On many occasions I had a thread stuck in JNI code and it wont work. Also in some cases thread.stop can cause jvm to hang. According to javadocs " This method is inherently unsafe. Stopping a thread with Thread.stop causes it to unlock all of the monitors that it has locked". I have used it only in some rare occasions where I wanted to avoid a system shutdown and in some cases we ended up doing system shutdown as jvm was hung so I had a 70-80% success with it.   -------------------------------------------------------------------------------------------------------------------------- We had an interesting requirement. A tomcat thread that was spawned from an ExecutorService ThreadPool had gone Rogue and was causing lots of disk churning issues. We cant bring down the production server as that would involve downtime. Killing this thread was harmless but how to kill it, t

Adding Jitter to cache layer

Thundering herd is an issue common to webapp that rely on heavy caching where if lots of items expire at the same time due to a server restart or temporal event, then suddenly lots of calls will go to database at same time. This can even bring down the database in extreme cases. I wont go into much detail but the app need to do two things solve this issue. 1) Add consistent hashing to cache layer : This way when a memcache server is added/removed from the pool, entire cache is not invalidated.  We use memcahe from both python and Java layer and I still have to find a consistent caching solution that is portable across both languages. hash_ring and spymemcached both use different points for server so need to read/test more. 2) Add a jitter to cache or randomise the expiry time: We expire long term cache  records every 8 hours after that key was added and short term cache expiry is 2 hours. As our customers usually comes to work in morning and access the cloud file server it can happe

Preparing for an interview after being employed 11 years at a startup

I would say I didn't prepared a hell lot but  I did 2 hours in night every day and every weekend around 8 hours for 2-3 months. I did 20-30 leetcode medium problems from this list https://leetcode.com/explore/interview/card/top-interview-questions-medium/.  I watched the first 12 videos of Lecture Videos | Introduction to Algorithms | Electrical Engineering and Computer Science | MIT OpenCourseWare I did this course https://www.educative.io/courses/grokking-the-system-design-interview I researched on topics from https://www.educative.io/courses/java-multithreading-for-senior-engineering-interviews and leetcode had around 10 multithreading questions so I did those I watched some 10-20 videos from this channel https://www.youtube.com/channel/UCn1XnDWhsLS5URXTi5wtFTA