Logzio logback appender<\/a> adds a logback appender which has all of the default configuration needed to communicate back to logz.io.<\/p>\n\n\n\nWe need to gather some information from logz.io so that we can connect to our account. Navigate to the send your logs menu item <\/p>\n\n\n\nSearch for Java<\/p>\n\n\n\nNavigate to logback<\/p>\n\n\n\nScroll down to the configuration and get the token<\/p>\n\n\n\nNow we just need to add some configuration so that logback understands how we want to log. Add a file called logback-spring.xml<\/code> to your src\/main\/resources<\/code> directory with this content<\/p>\n\n\n\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<configuration>\n <shutdownHook class=\"ch.qos.logback.core.hook.DelayingShutdownHook\"\/>\n <include resource=\"org\/springframework\/boot\/logging\/logback\/defaults.xml\"\/>\n <appender name=\"CONSOLE\" class=\"ch.qos.logback.core.ConsoleAppender\">\n <layout class=\"ch.qos.logback.classic.PatternLayout\">\n <Pattern>\n %black(%d{ISO8601}) %highlight(%-5level) [%blue(%t)] [%cyan(%X{trace_id}),%cyan(%X{span_id})] %yellow(%C{1.}): %msg%n%throwable\n <\/Pattern>\n <\/layout>\n <\/appender>\n <appender name=\"LogzioLogbackAppender\" class=\"io.logz.logback.LogzioLogbackAppender\">\n <token>${LOGZIO_LOGGER_TOKEN}<\/token>\n <logzioUrl>https:\/\/listener.logz.io:8071<\/logzioUrl>\n <logzioType>message-generator<\/logzioType>\n <\/appender>\n <springProfile name=\"dev\">\n <root level=\"info\">\n <appender-ref ref=\"CONSOLE\"\/>\n <\/root>\n <\/springProfile>\n <springProfile name=\"!dev\">\n <root level=\"info\">\n <appender-ref ref=\"CONSOLE\"\/>\n <appender-ref ref=\"LogzioLogbackAppender\"\/>\n <\/root>\n <\/springProfile>\n<\/configuration><\/code><\/pre>\n\n\n\nHere we’re setting up two appenders. Console will log out in a parsed string pattern which I think is easier to read and we’ve included some colors to help things stand out. Next we’re setting up the logback appender to push logs over to logz.io. Make sure to put your token in and make the logzioType reflect your service name since this is an attribute that matches the logs to your service. <\/p>\n\n\n\n
We’re also setting up some profile configuration so that when we’re developing locally we’re not necessarily pushing logs up to logz.io. You can turn this on and off by setting the active spring profile (-Dspring.profiles.active=dev<\/code>), but we’re going to leave this off for now while we’re testing.<\/p>\n\n\n\nWe don’t want logging to logz.io during our tests because this creates an unneeded dependency on an external system. So create this logback-test.xml<\/code> under src\/test\/resources<\/code><\/p>\n\n\n\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<configuration>\n <shutdownHook class=\"ch.qos.logback.core.hook.DelayingShutdownHook\"\/>\n <include resource=\"org\/springframework\/boot\/logging\/logback\/defaults.xml\"\/>\n <appender name=\"CONSOLE\" class=\"ch.qos.logback.core.ConsoleAppender\">\n <layout class=\"ch.qos.logback.classic.PatternLayout\">\n <Pattern>\n %d{ISO8601} %highlight(%-5level) [%cyan(%X{trace_id}),%cyan(%X{span_id})] %yellow(%C{1}): %msg%n%throwable\n <\/Pattern>\n <\/layout>\n <\/appender>\n\n <root level=\"INFO\">\n <appender-ref ref=\"CONSOLE\"\/>\n <\/root>\n<\/configuration><\/code><\/pre>\n\n\n\nYou should see a difference when you start up locally:And you should see your logs in logz.io<\/p>\n\n\n\n
Navigate to kibana<\/p>\n\n\n\nAnd you should see them in a few minutes (it takes some time to get them over, parsed, stored and indexed)<\/p>\n\n\n\nAdd Logs<\/h2>\n\n\n\n Our logging stance is pretty sparse at this point, so lets start beefing it up.<\/p>\n\n\n\n
I use an aspect to hang off of every method and log the input and output of each method. This removes the tedium of adding lots of log statements that need to be maintained. Aspects aren’t used a lot, but they can be handy. Be careful of overusing them though, because they hide a lot of functionality and can make debugging troublesome.<\/p>\n\n\n\n
First, add aspectj as a dependency to our pom.xml<\/code><\/p>\n\n\n\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-aop<\/artifactId>\n <\/dependency><\/code><\/pre>\n\n\n\nNext we’re going to use an annotation to activate the logging, so create the annotation in a new package called com.bullyrooks.messagegenerator.config<\/code>. Create a class called LoggingEnabled<\/code>.<\/p>\n\n\n\npackage com.bullyrooks.messagegenerator.config;\n\nimport java.lang.annotation.ElementType;\nimport java.lang.annotation.Retention;\nimport java.lang.annotation.RetentionPolicy;\nimport java.lang.annotation.Target;\n\n@Target(ElementType.TYPE)\n@Retention(RetentionPolicy.RUNTIME)\npublic @interface LoggingEnabled {\n}\n<\/code><\/pre>\n\n\n\nNow create the aspect in the same package as a class called LoggingAspect<\/code><\/p>\n\n\n\npackage com.bullyrooks.messagegenerator.config;\n\nimport com.fasterxml.jackson.core.JsonProcessingException;\nimport com.fasterxml.jackson.databind.ObjectMapper;\nimport com.fasterxml.jackson.databind.ObjectWriter;\nimport lombok.extern.slf4j.Slf4j;\nimport org.aspectj.lang.ProceedingJoinPoint;\nimport org.aspectj.lang.annotation.Around;\nimport org.aspectj.lang.annotation.Aspect;\nimport org.aspectj.lang.annotation.Pointcut;\nimport org.aspectj.lang.reflect.MethodSignature;\nimport org.springframework.stereotype.Component;\nimport org.springframework.util.StopWatch;\n\nimport java.util.HashMap;\nimport java.util.Map;\n\n@Aspect\n@Component\n@Slf4j\n@Profile(\"!test\")\npublic class LoggingAspect {\n\n ObjectMapper om = new ObjectMapper();\n\n @Pointcut(\"within(@com.bullyrooks.messagegenerator.config.LoggingEnabled *)\")\n public void loggingEnabled() {\n }\n\n @Pointcut(\"execution(public * *(..))\")\n public void publicMethod() {\n }\n\n @Pointcut(\"execution(private * *(..))\")\n public void privateMethod() {\n }\n\n\n @Around(\"loggingEnabled() && (publicMethod() || privateMethod())\")\n public Object profileAllMethods(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {\n logMethodInvocationAndParameters(proceedingJoinPoint);\n\n final StopWatch stopWatch = new StopWatch();\n\n \/\/Measure method execution time\n stopWatch.start();\n Object result = proceedingJoinPoint.proceed();\n stopWatch.stop();\n\n \/\/Log method execution time\n logMethodResultAndParameters(proceedingJoinPoint, result, stopWatch.getTotalTimeMillis());\n\n return result;\n }\n\n private void logMethodResultAndParameters(ProceedingJoinPoint proceedingJoinPoint,\n Object result, long totalTimeMillis) {\n try {\n MethodSignature methodSignature = (MethodSignature) proceedingJoinPoint.getSignature();\n String className = methodSignature.getDeclaringType().getSimpleName();\n String methodName = methodSignature.getName();\n ObjectWriter writer = om.writer();\n if (writer != null) {\n log.debug(\"<- {}.{} returns:{}. Execution time: {}ms\",\n className,\n methodName,\n writer.writeValueAsString(result),\n totalTimeMillis);\n }\n } catch (JsonProcessingException e) {\n log.error(\"unable to write log value: {}\", e.getMessage(), e);\n }\n }\n\n\n private void logMethodInvocationAndParameters(ProceedingJoinPoint jp) {\n try {\n String[] argNames = ((MethodSignature) jp.getSignature()).getParameterNames();\n Object[] values = jp.getArgs();\n Map<String, Object> params = new HashMap<>();\n if (argNames != null && argNames.length != 0) {\n for (int i = 0; i < argNames.length; i++) {\n params.put(argNames[i], values[i]);\n }\n }\n ObjectWriter writer = om.writer();\n if (writer != null) {\n String className = jp.getSignature().getDeclaringType().getSimpleName();\n String methodName = jp.getSignature().getName();\n log.debug(\"-> {}.{} invocation. params: {}\",\n className,\n methodName,\n writer.writeValueAsString(params));\n }\n } catch (JsonProcessingException e) {\n log.error(\"unable to write log value: {}\", e.getMessage(), e);\n }\n\n }\n}\n<\/code><\/pre>\n\n\n\nThere’s a lot going on here, I’ll try to help explain. <\/p>\n\n\n\n
First, we’re describing our pointcuts. These will be any class that has our annotation, any public method and any private method. Then I create a profile which combines those pointcuts and says what to execute. In this case, it says before the method is invoked, log the input, then start a timer, call the method and stop the timer when it returns and log the output.<\/p>\n\n\n\n
The logMethodInvocationAndParameters <\/code>method logs the input its a little complicated, but essentially, it grabs the input parameters, the class name and method and writes them to the log along with a direction arrow.<\/p>\n\n\n\nThe logMethodResultAndParameters<\/code> essentially does the same thing, but instead of getting the input parameters it has direct access to the returned object so it just logs that in json format.<\/p>\n\n\n\nFinally the @Profile annotation tells this aspect to ignore when running in the test profile, which means that our logs won’t get created during testing.<\/p>\n\n\n\n
Now, everything is logging at debug <\/code>level, so we’re going to need to adjust our log configuration to display them. Add these lines to your application.yaml<\/code><\/p>\n\n\n\nlogging:\n level:\n root: INFO\n com.bullyrooks: DEBUG<\/code><\/pre>\n\n\n\nThis is saying to log everything at INFO <\/code>level or above, except our packages which should log at DEBUG<\/code>.<\/p>\n\n\n\nFinally, add these annotations to MessageController <\/code>and MessageService<\/code><\/p>\n\n\n\n@LoggingEnabled\n@Slf4j<\/code><\/pre>\n\n\n\nRestart the application and hit the \/message<\/code> endpoint. You should see logs similar to this:<\/p>\n\n\n\nNote, this is almost<\/em> tracing (but isn’t nearly as good as it can be). Also, the logs are written via the aspect, so that aspect package and class are written here.<\/p>\n\n\n\nYou should also see them in logz.io<\/p>\n\n\n\nLets go ahead and push up these changes and deploy to okteto.<\/p>\n\n\n\n
git add .\n\ngit commit -m \"logging enabled\"\n\n\ngit push --set-upstream origin logging \nEnumerating objects: 33, done.\nCounting objects: 100% (33\/33), done.\nDelta compression using up to 4 threads\nCompressing objects: 100% (15\/15), done.\n...\n * [new branch] logging -> logging\nBranch 'logging' set up to track remote branch 'logging' from 'origin'.<\/code><\/pre>\n\n\n\nWhen that succeeds, merge to main<\/p>\n\n\n\n
git checkout main\n\ngit merge logging\n\ngit push<\/code><\/pre>\n\n\n\nOnce it builds and deploys we should see the logs in okteto’s consoleas well as in logz.io<\/p>\n\n\n\nNote, for some reason my debug logging level wasn’t getting passed through. You can verify the log level through actuator with this endpoint \/actuator\/loggers\/com.bullyrooks<\/code> (it was set to INFO<\/code>). You can use actuator to change the inflight configuration by POST<\/code>ing to that same endpoint with this body<\/p>\n\n\n\n{\"configuredLevel\": \"DEBUG\"}<\/code><\/pre>\n\n\n\nIf you GET again, you should see it updated<\/p>\n\n\n\n
{\n \"configuredLevel\": \"DEBUG\",\n \"effectiveLevel\": \"DEBUG\"\n}<\/code><\/pre>\n\n\n\nUpdate Cloud Application<\/h2>\n\n\n\n Now, make the same updates to cloud application and push that up to okteto before we move on to the tracing.<\/p>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
\nAdd Structured Logging Structured logging means that we’re going to log our…\n<\/div>\n
Continue reading “Kube Cloud Pt4 | Logging”<\/span>…<\/a><\/div>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[41],"tags":[187,186,183,185,184,165],"course":[164],"class_list":["post-1278","post","type-post","status-publish","format-standard","hentry","category-software-development","tag-aop","tag-aspect-oriented-programming","tag-elk","tag-kibana","tag-logback","tag-logz-io","course-kube-cloud-4-observability","entry"],"jetpack_featured_media_url":"","jetpack-related-posts":[{"id":1276,"url":"https:\/\/bullyrooks.com\/index.php\/2022\/02\/19\/kube-cloud-pt4-observability\/","url_meta":{"origin":1278,"position":0},"title":"Kube Cloud Pt4 | Observability","author":"Bullyrook","date":"February 19, 2022","format":false,"excerpt":"In this course, I'm going to walk through how to implement the 3 pillars of observability on our example application using the logz.io platform. Before we do that, I'm going to explain the 3 pillars of observability, which are: LoggingTracingMetrics Logging Logz.io uses ELK for their log management platform. There's\u2026","rel":"","context":"In "Software Development"","block_context":{"text":"Software Development","link":"https:\/\/bullyrooks.com\/index.php\/category\/software-development\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":831,"url":"https:\/\/bullyrooks.com\/index.php\/2020\/03\/30\/simple-spring-boot-service-to-kubernetes-application-step-5-a2d164711554\/","url_meta":{"origin":1278,"position":1},"title":"Logging, Tracing and Error Handling","author":"Bullyrook","date":"March 30, 2020","format":false,"excerpt":"Now that we\u2019ve got an almost fully functional webservice we\u2019re going to make sure that we can debug it properly before moving forward to deployment. In this article we\u2019re going to describe how to setup logging. Logging We need to start by actually logging something. Spring boot comes packaged with\u2026","rel":"","context":"In "Software Development"","block_context":{"text":"Software Development","link":"https:\/\/bullyrooks.com\/index.php\/category\/software-development\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1395,"url":"https:\/\/bullyrooks.com\/index.php\/2022\/03\/12\/kube-cloud-pt6-update-to-consumer-contract\/","url_meta":{"origin":1278,"position":2},"title":"Kube Cloud Pt6 | Break the Contract from a Consumer Change","author":"Bullyrook","date":"March 12, 2022","format":false,"excerpt":"We're going to go back to cloud-application at this point and update our client to expect a field that isn't being currently provided (message generated date). This should break our contract test and prevent us from deploying, but there's some updates we need to make to support this. Add the\u2026","rel":"","context":"In "Software Development"","block_context":{"text":"Software Development","link":"https:\/\/bullyrooks.com\/index.php\/category\/software-development\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/03\/image-25.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/03\/image-25.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/03\/image-25.png?resize=700%2C400&ssl=1 2x"},"classes":[]},{"id":1301,"url":"https:\/\/bullyrooks.com\/index.php\/2022\/02\/20\/kube-cloud-pt4-metrics\/","url_meta":{"origin":1278,"position":3},"title":"Kube Cloud Pt4 | Metrics","author":"Bullyrook","date":"February 20, 2022","format":false,"excerpt":"Logz.io uses prometheus for metrics. Go ahead and enable metrics collection in logz.io. Navigate to send your metrics Search for java Choose java custom metrics via micrometer. We're using micrometer because its integrated into spring boot and available via actuator, which we're already using. The important part here is that\u2026","rel":"","context":"In "General"","block_context":{"text":"General","link":"https:\/\/bullyrooks.com\/index.php\/category\/general\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-22.png?resize=350%2C200&ssl=1","width":350,"height":200},"classes":[]},{"id":1094,"url":"https:\/\/bullyrooks.com\/index.php\/2021\/07\/24\/terraform-setup-and-first-install\/","url_meta":{"origin":1278,"position":4},"title":"Terraform Setup and First Install","author":"Bullyrook","date":"July 24, 2021","format":false,"excerpt":"Terraform is a system that allows you to define your infrastructure in a series of configuration files. These configuration files are linked to a provider library which will execute the infrastructure create, update and teardown commands on the platform you want to deploy to. This is called \"Infrastructure as Code\"\u2026","rel":"","context":"In "Software Development"","block_context":{"text":"Software Development","link":"https:\/\/bullyrooks.com\/index.php\/category\/software-development\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2021\/07\/image-19.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2021\/07\/image-19.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2021\/07\/image-19.png?resize=700%2C400&ssl=1 2x, https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2021\/07\/image-19.png?resize=1050%2C600&ssl=1 3x"},"classes":[]},{"id":706,"url":"https:\/\/bullyrooks.com\/index.php\/2021\/01\/28\/installing-transmission-with-openvpn\/","url_meta":{"origin":1278,"position":5},"title":"Installing Transmission with OpenVPN","author":"Bullyrook","date":"January 28, 2021","format":false,"excerpt":"Now we're going to setup a bittorrent client as well as an OpenVPN client to keep our traffic secure. This is another straightforward docker-compose modification. Get an OpenVPN Provider You'll need a VPN provider. I highly recommend private internet access because I've been using them for years. They have good\u2026","rel":"","context":"In "Home Networking"","block_context":{"text":"Home Networking","link":"https:\/\/bullyrooks.com\/index.php\/category\/technology\/home-networking\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2021\/01\/image-80.png?resize=350%2C200&ssl=1","width":350,"height":200},"classes":[]}],"_links":{"self":[{"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/posts\/1278","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/comments?post=1278"}],"version-history":[{"count":10,"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/posts\/1278\/revisions"}],"predecessor-version":[{"id":1332,"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/posts\/1278\/revisions\/1332"}],"wp:attachment":[{"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/media?parent=1278"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/categories?post=1278"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/tags?post=1278"},{"taxonomy":"course","embeddable":true,"href":"https:\/\/bullyrooks.com\/index.php\/wp-json\/wp\/v2\/course?post=1278"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-6.png?resize=303%2C365&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-7.png?resize=564%2C406&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-8-1024x261.png?resize=960%2C245&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-9.png?resize=759%2C341&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-10-1024x376.png?resize=960%2C353&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-11.png?resize=303%2C128&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-12-1024x535.png?resize=960%2C502&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-13-1024x65.png?resize=960%2C61&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-14-1024x126.png?resize=960%2C118&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-16-1024x110.png?resize=960%2C103&ssl=1\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/bullyrooks.com\/wp-content\/uploads\/2022\/02\/image-17-1024x137.png?resize=960%2C128&ssl=1\")
<\/figure>\n\n\n\n