Maintenance 102

Maintainability — Logs & Their Use

An application that logs properly will make maintenance easier.

Oliver de Cramer
Sep 22, 2020 · 8 min read

What to Log & How to Log

Logging for diagnostic

<?php$response = $this->httpClient->get($endpoint, $query);
if ($response->getStatusCode() != 200) {
$this->logger->warning(
"Failed to fetch test data from test api",
[
"endpoint" => $endpoint,
"query" => $query,
"status_code" => $response->getStatusCode(),
"body" => $response->getBody()
]
);
throw new MyApiException("Failed to fetch data from test api");
}

Logging for Debug

<?php
$this->logger->debug(
"Fetching test data from test api",
[
"endpoint" => $endpoint,
"query" => $query,
]
);
$response = $this->httpClient->get($endpoint, $query);
if ($response->getStatusCode() != 200) {
$this->logger->warning(
"Failed to fetch test data from test api",
[
"endpoint" => $endpoint,
"query" => $query,
"status_code" => $response->getStatusCode(),
"body" => $response->getBody()
]
);
throw new MyApiException("Failed to fetch data from test api");
}
$this->logger->debug(
"Fetched tes data from test api",
[
"endpoint" => $endpoint,
"query" => $query,
"body" => $response->getBody() ]
);

Log for Statistics

Why are logs so important?

Be retroactive

Understand the impact

Understand the issue

How to fix the issue

Conclusion

The Startup

Get smarter at building your thing. Join The Startup’s +787K followers.

Sign up for Top 10 Stories

By The Startup

Get smarter at building your thing. Subscribe to receive The Startup's top 10 most read stories — delivered straight into your inbox, once a week. Take a look.

By signing up, you will create a Medium account if you don’t already have one. Review our Privacy Policy for more information about our privacy practices.

Check your inbox
Medium sent you an email at to complete your subscription.

Oliver de Cramer

Written by

Passionate web developer. Symfony lover. Writing as a hobby. Sad Magento 2 developer

The Startup

Get smarter at building your thing. Follow to join The Startup’s +8 million monthly readers & +787K followers.

Oliver de Cramer

Written by

Passionate web developer. Symfony lover. Writing as a hobby. Sad Magento 2 developer

The Startup

Get smarter at building your thing. Follow to join The Startup’s +8 million monthly readers & +787K followers.

Medium is an open platform where 170 million readers come to find insightful and dynamic thinking. Here, expert and undiscovered voices alike dive into the heart of any topic and bring new ideas to the surface. Learn more

Follow the writers, publications, and topics that matter to you, and you’ll see them on your homepage and in your inbox. Explore

If you have a story to tell, knowledge to share, or a perspective to offer — welcome home. It’s easy and free to post your thinking on any topic. Write on Medium

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store