New post

Author: SimonTaylor

.gitignore

@@ -5,3 +5,4 @@ _site
 vendor/bundle
 
 *.iml
+.idea

_layouts/post.html

@@ -4,7 +4,7 @@
 <article class="post h-entry" itemscope itemtype="http://schema.org/BlogPosting">
 
   <header class="post-header">
-    <h1 class="post-title p-name fs-3" itemprop="name headline">{{ page.title | escape }}</h1>
+    <h1 class="post-title p-name fs-3 mt-3" itemprop="name headline">{{ page.title | escape }}</h1>
 
     <div class="my-3 text-uppercase text-truncate">
       {%- assign date_format = site.minima.date_format | default: "%b %-d, %Y" -%}

_posts/2021-10-03-spt-development-audit-spring.markdown

@@ -14,7 +14,7 @@ In this post I introduce the features of [spt-development-audit-spring](https://
 {: class="lead"}
 
 ## Demo project
-{: class="fs-3" }
+{: class="fs-4" }
 
 The demo project provides a simple 'books' REST API backed by and in-memory H2 database with basic authentication configured with Spring Security. Once running, the REST API can then be exercised with cURL as follows:
 
@@ -23,12 +23,12 @@ The demo project provides a simple 'books' REST API backed by and in-memory H2 d
 See the [README](https://github.com/spt-development/spt-development-demo/blob/main/README.md) for more detail.
 
 ## Auditing
-{: class="fs-3" }
+{: class="fs-4" }
 
 There are many reasons why you might want to add auditing to your application. The main reason we wanted to add auditing to [SPT Contractors](https://spt.contractors/) was to be able to trace through how records reached a particular state; having this information has been invaluable on past projects for replaying when things go wrong and answering user queries when records are in a state they don't expect. We wanted an auditing solution that was simple to implement without polluting my business logic with calls to persist the audit records. Additionally, we wanted another service to be responsible for persisting the audit records which could potentially be extended to perform analysis or transformations at a later date. Out of these requirements `spt-development-audit-spring` was born.
 
 ## spt-development-audit-spring
-{: class="fs-3" }
+{: class="fs-4" }
 
 The demo project uses the `spt-development-audit-spring-boot-starter` to pull in the required dependencies and automatically configure the auditor. The demo project also has a dependency on the [spt-development-cid-web-spring-boot](https://github.com/spt-development/spt-development-cid-web-spring-boot) starter in order to pull in and configure `spt-development-cid-web` and its dependencies so that the correlation ID on the audit event records is set correctly (see [earlier post]({% post_url 2021-05-30-spt-development-cid-part-2 %}) for more details). The demo project also uses the [spt-development-logging-spring-boot](https://github.com/spt-development/spt-development-logging-spring-boot) starter (also discussed in my earlier post) and the [spt-development-cid-jms-spring-boot](https://github.com/spt-development/spt-development-cid-jms-spring-boot) starter that I will talk about in greater depth, later in this post.
 
@@ -57,14 +57,14 @@ Multiple parameters can be annotated with `@Audited.Detail` but if you do, the `
 The `spt-development-audit-spring-boot-starter` configures the `Slf4jAuditEventWriter` bean by default, which is an instance of the `AuditEventWriter` interface. In a production service you probably want your adit event records persisted to some kind of database, in which case you will need to create a bean that is an instance of `AuditEventWriter` or if your service methods are transactional, an instance of `TransactionAwareAuditEventWriter` so that the audit events are only written if the transaction is successfully committed. For SPT Contractors, we developed a separate service responsible for persisting the audit event records read from a JMS queue and would recommend this approach in general. Creating a `JmsTemplate` bean and setting the `spt.audit.jms.destination` property results in the `spt-development-audit-spring-boot-starter` instantiating a `JmsAuditEventWriter` bean which writes the audit event records to the configured JMS queue, rather than to the logs with `Slf4jAuditEventWriter`. The demo project uses an in-memory Artemis JMS queue to demonstrate this.
 
 ## Actuator audit events
-{: class="fs-3" }
+{: class="fs-4" }
 
 It is very straight forward to integrate `spt-development-auditor` with [Actuator Auditing](https://docs.spring.io/spring-boot/docs/2.5.5/reference/html/actuator.html#actuator.auditing) which allows you to treat business audit events and actuator audit events (for example generated by Spring Security) in a consistent manner. Simply create a class that extends `AbstractAuditListener` inject a `AuditEventWriter` bean and in the `AbstractAuditListener::onAuditEvent()` method write the audit events with the audit event writer. The demo project uses this approach to audit successful and unsuccessful login attempts.
 
 {% gist bf66f89f8c3e49d23bb4850255c76814 %}
 
 ## spt-development-cid-jms-spring
-{: class="fs-3" }
+{: class="fs-4" }
 
 `spt-development-cid-jms-spring` integrates `spt-development-cid` into a Spring JMS (listener) project, initialising the correlation ID from the correlation ID of the received JMS message. The demo project shows the easiest way to integrate `spt-development-cid-jms-spring` into a Spring Boot application, with `spt-development-cid-jms-spring-boot-starter`. If your listener methods have a single `Message` parameter, there is nothing further to do. If your listener methods accept a `@Payload` annotated parameter, they will need an additional parameter annotated with the `@Header` annotation and the name set to `jms_correlationId` as shown in the `AuditListener::onMessage` method of the demo project.
 

_posts/2022-04-11-spt-development-release.markdown

@@ -21,13 +21,13 @@ Just to reiterate, there is nothing wrong with versions 2.0.1 to 2.0.11 other th
 {: class="lead"}
 
 ## Automated Release
-{: class="fs-3" }
+{: class="fs-4" }
 
 Below is a summary of some of the problems we ran into whilst trying to automate the release process with
 [Travis CI](https://www.travis-ci.com) and the solutions we found.
 
 ### `maven-release-plugin` requires full clone of repository
-{: class="fs-4" }
+{: class="fs-5" }
 
 `mvn release:prepare release:perform -B` will update the versions and kick off the Maven `deploy` phase - we already had
 the relevant plugins configured to deploy to sonatype with `mvn deploy -Prelease`. Out of the box, Travis performs
@@ -41,22 +41,22 @@ The other commands in the install phase are used to capture the version number f
 signing the jars uploaded to Sonatype.
 
 ### Deploy stage requires values from maven `settings.xml`
-{: class="fs-4" }
+{: class="fs-5" }
 
 Add encrypted environment variables and reference them in a custom settings file referenced with the `--settings` 
 mvn parameter.
 
 {% gist 08ac0b5568df5e96510dd5025d3194d3 %}
 
 ### Inability to encrypt special characters in environment variables properly
-{: class="fs-4" }
+{: class="fs-5" }
 
 `cd` to a clone of the repository and use the following command, entering `ENV_VAR=value` when prompted:
 
 {% gist 076ce4d2d6597d7f96ee94b49c519fa6 %}
 
 ### Prevent checkins by `maven-release-plugin` kicking off another build (and release)
-{: class="fs-4" }
+{: class="fs-5" }
 
 Use the `scmCommentPrefix` setting of `maven-release-plugin` to include `[skip travis]`.
 
@@ -67,7 +67,7 @@ Note also the `goals` configuration setting with the value `deploy`. If a distri
 To upload to Github, we need to use the releases provider; specifying `deploy` runs the `deploy` phase instead.
 
 ### Create the release in Github
-{: class="fs-4" }
+{: class="fs-5" }
 
 The Travis [Github releases provider](https://docs.travis-ci.com/user/deployment/releases/) makes this straight forward, 
 however it is tightly coupled to tagging a particular version of the code. In order to prevent an infinite loop of

_posts/2022-09-24-dance-dad-burning-cds.markdown

@@ -18,28 +18,28 @@ to use [ffmpeg](https://ffmpeg.org/) to convert the downloaded file from [mp4](h
 [mp3](https://en.wikipedia.org/wiki/MP3), before using [Apple Music](https://en.wikipedia.org/wiki/Apple_Music) to burn the music to CD.
 
 ## Downloading audio files from Facebook Messenger
-{: class="fs-3" }
+{: class="fs-4" }
 
 Facebook used to make it fairly straight forward to download audio files from Messanger, for some reason they now make it as difficult as
 possible. These steps were performed in Google Chrome on Mac OS, but shouldn't vary too much from browser to browser, or OS to OS. They
 will need to be performed on a desktop rather than mobile device however.
 
 ### 1. Open messages
-{: class="fs-4" }
+{: class="fs-5" }
 
 Browse to the messages containing the audio file(s).
 
 ![facebook messenger](/assets/images/2022-09-24-dance-dad-burning-cds/facebook-messenger.jpeg){:class="img-fluid"}
 
 ### 2. Open up browser dev tools
-{: class="fs-4" }
+{: class="fs-5" }
 
 Hit F12 or however you prefer to open the browser dev tools and then select the network tab.
 
 ![idev tools](/assets/images/2022-09-24-dance-dad-burning-cds/dev-tools.jpeg){:class="img-fluid"}
 
 ### 3. Play the audio file
-{: class="fs-4" }
+{: class="fs-5" }
 
 Click on the audio file to start it playing. If you have already played it, then refresh the Facebook Messenger page first and clear out the 
 network history to make it easier to see which audio file was downloaded when you hit play. Then right click the audio file that appears
@@ -52,7 +52,7 @@ I found no way of tying an mp4 file to a particular message, so I had to right c
 one I wanted.]
 
 ## Converting mp4 to mp3
-{: class="fs-3" }
+{: class="fs-4" }
 
 If you received an mp3 file, this step can be skipped. If you received an mp4 for example, then you will need to convert it
 to an mp3 file. If you try buring an mp4 file to CD, you will find that only the first 6 seconds gets written to the CD. I used ffmpeg
@@ -61,10 +61,10 @@ that I had previously installed with [brew](https://formulae.brew.sh/formula/ffm
 {% gist c65fe53fa7f379108e3fe6e956254c48 %}
 
 ## Burning the audio file to CD
-{: class="fs-3" }
+{: class="fs-4" }
 
 ### 1. Create a new playlist
-{: class="fs-4" }
+{: class="fs-5" }
 
 Open Apple Music and create a new playlist.
 
@@ -73,14 +73,14 @@ Open Apple Music and create a new playlist.
 ![new playlist](/assets/images/2022-09-24-dance-dad-burning-cds/new-play-list-2.jpeg){:class="img-fluid"}
 
 ### 2. Add the audio file to the playlist
-{: class="fs-4" }
+{: class="fs-5" }
 
 Find the previously downloaded/converted file in finder and drag it and drop it on to the newly created playlist in Apple Music.
 
 ![new playlist](/assets/images/2022-09-24-dance-dad-burning-cds/new-play-list-3.jpeg){:class="img-fluid"}
 
 ### 3. Burn the CD
-{: class="fs-4" }
+{: class="fs-5" }
 
 With a blank CD already inserted into the CD burner, right click the newly created playlist and select "Burn Playlist to Disc..."; in
 the dialog that is opened, leave the defaults selected and click "Burn" - the "Audio CD" format seems to be the most likely format to work,
@@ -91,6 +91,6 @@ in a random CD player, but make sure you test the burnt CD!
 ![burn cd](/assets/images/2022-09-24-dance-dad-burning-cds/burn-cd-2.jpeg){:class="img-fluid"}
 
 ### 4. Test the CD!!!
-{: class="fs-4" }
+{: class="fs-5" }
 
 I tested it in an old CD player to give confidence that it will probably work at the dance festival.

_posts/2022-10-26-spt-development-release.markdown

@@ -35,7 +35,7 @@ Additionally, the following libraries have also been updated:
 We have also upgraded the [demo project](https://github.com/spt-development/spt-development-demo) to v2.0.10 of all the libraries above.
 
 ### Mapped Diagnostic Context
-{: class="fs-4" }
+{: class="fs-5" }
 
 Simply adding v2.0.10 spt-development-cid-web-spring-boot-starter or spt-development-cid-jms-spring-boot-starter (depending on your requirements)
 as a dependency to your project, will be enough to have the correlation ID added to the [Mapped Diagnostic Context](https://logback.qos.ch/manual/mdc.html) 
@@ -59,7 +59,7 @@ shows the changes made to the demo project to remove the explicit inclusion of c
 spt-development-logging-spring-boot, the number of changes will be reduced.
 
 #### Disable MDC
-{: class="fs-5" }
+{: class="fs-6" }
 
 Although it is the default functionality and recommended approach, if you don't want to use MDC, maybe because you already have `CorrelationId.get()` calls
 in log statements scattered throughout your code, then it it is possible to disable this new functionality by setting the `spt.cid.mdc.disabled` property to `true`.
@@ -68,7 +68,7 @@ is purely for demonstration and testing purposes however and not expected to be
 no reason why it couldn't be.
 
 ### Why the U-turn
-{: class="fs-4" }
+{: class="fs-5" }
 
 It was a conscious decision [early on]({% post_url 2021-05-30-spt-development-cid-part-2 %}) *not* to use the MDC. However, having had feedback from various
 users, it became eveident that this was a feature that was lacking in the library and having to explicitly add `CorrelationId.get()` explicitly to log

_posts/2023-05-14-micrometer-trace-integration.markdown

@@ -21,7 +21,7 @@ excerpt: |
 {{ page.excerpt | remove: '<span class="d-inline d-md-none d-xl-inline">' | remove: '</span>' }}
 
 ## Micrometer Tracing
-{: class="fs-3" }
+{: class="fs-4" }
 
 All of the code from this post can be found in the 
 [spt-development-micrometer-tracing-demo](https://github.com/spt-development/spt-development-micrometer-tracing-demo) project, which was forked
@@ -43,7 +43,7 @@ Spring Boot samples only 10% of requests to prevent overwhelming the trace backe
 property; this is not necessary for this demo where we are only logging to the console.
 
 ### Gotcha!
-{: class="fs-4" }
+{: class="fs-5" }
 
 One thing that I struggled to find mentioned in the documentation was that tracing is *switched off* by default in tests. This is 
 [intended](https://github.com/spring-projects/spring-boot/issues/31308){:target="_blank"} and therefore when I ran the tests initially, the trace 
@@ -53,7 +53,7 @@ annotation to the integration tests, which can be used to enable/disable metrics
 {% gist b785e325630c7dcb1eeaefab50df29b0 %}
 
 ## Auditing
-{: class="fs-3" }
+{: class="fs-4" }
 
 Adding the `spt-development-audit-spring-boot-starter` dependency to the project pulls in the required dependencies and automatically configures the
 auditor. Since we are going to be using the Micrometer trace ID in place of the correlation ID, we can exclude the `spt-development-cid` 
@@ -70,15 +70,15 @@ With this in place and methods annotated as described in [this post]({% post_url
 fully audited and audit events can be correlated using the trace ID.
 
 ### Actuator audit events
-{: class="fs-4" }
+{: class="fs-5" }
 
 If you are capturing actuator events as described in the previous [auditing post]({% post_url 2021-10-03-spt-development-audit-spring %}) you 
 need to inject the `Tracer` bean into your audit event listener and again use the current trace ID in place of the correlation ID.
 
 {% gist c7af3532347d0d14fb35646d27d88eae %}
 
 ### JMS Propagation
-{: class="fs-4" }
+{: class="fs-5" }
 
 The demo project makes use of `JmsAuditEventWriter` simply by configuring the `spt.audit.jms.destination` property. The Micrometer trace context
 is not currently propagated in JMS messages by default; there is currently an 
@@ -90,7 +90,7 @@ the correlation ID returned by the `CorrelationIdProvider`.
 {% gist e442d6398602902177ff622bcfbf786e %}
 
 ## Logging
-{: class="fs-3" }
+{: class="fs-4" }
 
 As previously written about in more detail [here]({% post_url 2021-05-30-spt-development-cid-part-2 %}) simply add the `spt-development-logging-spring-boot-starter`
 as a dependency to get production quality logging added to your application without any further code changes. With the logging format changes above, you will then

_posts/2024-07-14-spring-boot-3.3.1-starters-available-now.markdown

@@ -41,6 +41,7 @@ We have also upgraded the [demo project](https://github.com/spt-development/spt-
 [Micrometer demo project](https://github.com/spt-development/spt-development-micrometer-tracing-demo) to Spring Boot 3.3.1 and v3.3.1 of all the libraries above.
 
 ### spt-development-logging-spring - Arbitrary bean logging support
+{: class="fs-5" }
 
 Release 3.2.0 of `spt-development-logging-spring` introduces support for logging public methods of arbitrary beans. This logging is enabled by adding the
 `EnableBeanLogging` annotation to your project. The `includeBasePackageClasses` must contain at least one class and enables logging of Spring beans from the same package as any of the classes specified.