How to integrate stackdriver logging with django web application?

Published on April 27,2020 by Maulik

Let us learn how to use “Stackdriver logging with Django.” If you are running your Django application in the production server, errors show up. You need a log viewing and searching tool to debug production errors. These days you do not need to download error log files from a server and check it in your local machine. Stackdriver is now known as Google Cloud Logging. It is a great tool to monitor logs and file bugs for the Django production server automatically. All Django lovers, I hope you are going to love this article.

What is stackdriver?

Stackdriver is a logging and monitoring tool; now, it is known as Google Cloud Logging. Developers require to check logs in the production server, file a bug, and diagnose the root cause of the error. Imagine we can not see logs while developing the Django application in our local machine. We can not debug things. Django applications running in the production server can too throw error logs, we need a swift tool to search logs and find the cause of errors. Stackdriver automatically files a bug in the Google Cloud Error Reporting tool.

What is the cost of using stackdriver/cloud logging API with the Django application?

You might be running your Django application on a private server or virtual machine on public clouds like Google Cloud, Digital Ocean, or AWS. Stackdriver or Google cloud logging can be integrated in the same manner as described in this article. If you are thinking about how much it is going to cost this tool for monitoring the Django logs, the answer is you can store up to 50 GB of logs for FREE.

If you think you are going to store more than 50 GB of logs from the Django application to Stackdriver, please check to google cloud pricing calculator.

Steps to use stackdriver with Django application:

Please check the Django stack driver logging project on Github.

The directory structure of the project is as below:

.
├── manage.py
├── requirements.txt
├── service-account.json # < get this file from GCP console.
└── stackdriver_logging
    │   ├── __init__.py
    │   ├── log_middleware.py
    │   ├── settings.py
    │   ├── urls.py
    │   ├── views.py
    │   ├── wsgi.py

Create the service account credentials for accessing the stackdriver/ Google cloud logging API.

What is service account credentials?

Google Cloud provides an authentication mechanism where we can create a credential for accessing the API with limited rights to the API. Our Django application needs to consume Google Cloud Logging API, so service account credentials are used by our Django application to make stackdriver or Google Cloud Logging API calls.

Create a service account from google cloud console service account page
Enter the Service Account name and click on the “Create” button.
In the Service Account Permissions step, set the Service Account role to “Logging Admin” and click the continue button.
For generating the Service Account JSON file, click on the “Create Key” button, then select the key type to “JSON” and click on the create button. It downloads the Service Account JSON file.
Let us keep this credential file at the root directory of our project.
The project directory structure should look like as below:
.
├── manage.py
├── requirements.txt
├── service-account.json # < get this file from GCP console.
└── stackdriver_logging
    │   ├── __init__.py
    │   ├── log_middleware.py
    │   ├── settings.py
    │   ├── urls.py
    │   ├── views.py
    │   ├── wsgi.py

create stackdriver logging handler in Django

Create a log_middleware.py file in the main app and write the following code in it.
- stackdriver_logging/log_middleware.py

from google.cloud.logging.resource import Resource
from google.cloud import logging as gcp_logging
import io
import logging
import json
 
json_credentials_path='service-account.json'
 
client = gcp_logging.Client.from_service_account_json(json_credentials_path)
client.setup_logging()
 
client_email = ""
with io.open(json_credentials_path, "r", encoding="utf-8") as file:
   credentials_info = json.load(file)
   client_email = credentials_info["client_email"]

_LOG_RESOURCE = Resource(
   type='service_account',
   labels={
       "email_id":  client_email,
       "project_id":  client.project
   }
)
 
class StackDriverHandler(logging.Handler):
 
   def __init__(self):
       logging.Handler.__init__(self)
 
   def emit(self, record):
       """Add record to cloud"""
       self.logger = client.logger('stackdriver.googleapis.com%2Fapp')
       self.log_msg = self.format(record)
       self.logger.log_text(self.log_msg, severity=record.levelname, resource=_LOG_RESOURCE)

Add stackdriver logging handler to Django’s settings.py

LOGGING = {
   'version': 1,
   'disable_existing_loggers': False,
   'formatters': {
       'standard': {'format': '%(levelname)s : %(message)s - [in %(pathname)s:%(lineno)d]'},
       'short': {'format': '%(message)s'}
   },
   'handlers': {
       'stackdriver': {
           'formatter': 'standard',
           'class': 'stackdriver_logging.log_middleware.StackDriverHandler',
       },
   },
   'loggers': {
       'StackDriverHandler': {
           'handlers': ['stackdriver'],
           'level': "INFO"
       },
       'django.request': {
           'handlers': ['stackdriver']
       }
   },
}

Use stackdriver logger in views

To use the logging handler in your views, you have to create the logger object and use it in the views.

from rest_framework.response import Response
from rest_framework.views import APIView
import logging
 
logger = logging.getLogger('StackDriverHandler')
 
class UserView(APIView):
   def get(self, request):
 
       logger.info("Init log from view")
       logger.warning("Warning: Init log from view")
       logger.error("Test error")
      
       return Response("Success")

Call your endpoint from the external source ( like Postman ). It should return the success response.

Viewing Django logs in stackdriver/Google cloud console.

Now view the logs, open the stackdriver logging on your google cloud console, and select the service account which you created before in step 1.
We can view the logs in the stackdriver.

Conclusion:

We have successfully integrated the stackdriver logging/ google cloud logging tool to our Django application. Stackdriver is a fantastic tool for searching error logs. Yes, you should get rid of the legacy way of handling and viewing logs of your Django applications.

Thanks for taking the time to check out this article.

I hope it adds real value to your project.

1165 Comments

RobertEstib

1 hour, 58 minutes

https://gabapentin.icu/# neurontin 800 mg

Isiahfug

2 hours, 1 minute

diflucan oral <a href=" https://diflucan.icu/# ">diflucan pill for sale</a>

Michealdug

3 hours, 12 minutes

[url=https://gabapentin.icu/#]medicine neurontin capsules[/url] neurontin oral

Jefferywex

6 hours, 36 minutes

where can i buy cipro online <a href=" https://cipro.best/# ">cipro for sale</a>

DopCS

16 hours, 21 minutes

https://coronavirus-control.ru/chto-takoe-samoreguliruemye-organizaczii/

Thomasassex

18 hours, 9 minutes

how to get diflucan <a href=" https://diflucan.icu/# ">buy diflucan 150 mg</a> https://withoutprescription.store/# buy prescription drugs without doctor [url=https://withoutprescription.store/#]canadian drugstore online[/url] prescription drugs without prior prescription

RobertEstib

18 hours, 27 minutes

https://cipro.best/# ciprofloxacin mail online

Michealdug

21 hours, 4 minutes

[url=https://erectionpills.best/#]natural ed medications[/url] ed drugs list

Jefferywex

21 hours, 46 minutes

prescription drugs <a href=" https://withoutprescription.store/# ">prescription meds without the prescriptions</a>

Thomasassex

1 day, 9 hours

online diflucan <a href=" https://diflucan.icu/# ">diflucan pill</a> https://diflucan.icu/# diflucan 6 tabs [url=https://diflucan.icu/#]generic diflucan 150 mg[/url] cost of diflucan

RobertEstib

1 day, 10 hours

https://erectionpills.best/# п»їerectile dysfunction medication

Jefferywex

1 day, 14 hours

neurontin 1800 mg <a href=" https://gabapentin.icu/# ">neurontin 100 mg capsule</a>

Isiahfug

1 day, 15 hours

buy prescription drugs online without <a href=" https://withoutprescription.store/# ">pain meds online without doctor prescription</a>

GeorgeRic

1 day, 16 hours

https://erectionpills.best/# ed pills otc

RobertEstib

2 days, 3 hours

https://erectionpills.best/# ed medication online

Andrewusevy

2 days, 4 hours

medicine erectile dysfunction <a href=" https://erectionpills.best/# ">pills erectile dysfunction</a> https://withoutprescription.store/# non prescription erection pills [url=https://gabapentin.icu/#]neurontin 100mg tab[/url] neurontin prices generic

Thomasassex

2 days, 6 hours

ed medications list <a href=" https://erectionpills.best/# ">what are ed drugs</a> https://gabapentin.icu/# neurontin for sale online [url=https://gabapentin.icu/#]buy cheap neurontin[/url] neurontin 100mg discount

RobertEstib

2 days, 19 hours

https://diflucan.icu/# order diflucan

Www.provenexpert.com

2 days, 20 hours

4 days, 12 hours

prescription drugs without prior prescription <a href=" https://withoutprescription.store/# ">canadian pharmacy online</a> https://erectionpills.best/# medicine erectile dysfunction [url=https://erectionpills.best/#]erectile dysfunction medicines[/url] ed dysfunction treatment

Thomasassex

4 days, 14 hours

diflucan 150 mg tablet <a href=" https://diflucan.icu/# ">buy diflucan online usa</a> https://gabapentin.icu/# neurontin [url=https://diflucan.icu/#]diflucan buy[/url] can i buy diflucan in mexico

RobertEstib

4 days, 19 hours

https://withoutprescription.store/# prescription drugs online without doctor

Hilario

5 days

I do not know whether it's just me or if perhaps everyone else experiencing problems with your blog. It appears as though some of the written text in your posts are running off the screen. Can somebody else please comment and let me know if this is happening to them as well? This might be a problem with my web browser because I've had this happen before. Thank youit will be on mehttp://bzhncvnxplea.mee.nu/?entry=3346855http://maxton8zj9v5.mee.nu/?entry=3342857

GeorgeRic

5 days, 5 hours

https://gabapentin.icu/# neurontin 1200 mg

Thomasassex

5 days, 11 hours

natural ed remedies <a href=" https://erectionpills.best/# ">best ed medication</a> https://cipro.best/# ciprofloxacin mail online [url=https://diflucan.icu/#]diflucan 150 mg over the counter[/url] diflucan 2 pills

RobertEstib

5 days, 11 hours

https://diflucan.icu/# diflucan 125mg

IckDH

6 days, 3 hours

Synthroid (Levothyroxine) is a prescription medicine that contains synthetic thyroid hormones used to treat hypothyroidism, or underactive thyroid levels. This medication also treats goiter, a condition where the thyroid gland becomes enlarged from too much hormone production. <a href="https://synthroid4us.top">synthroid pill</a>

RobertEstib

6 days, 4 hours

https://erectionpills.best/# best pills for ed

Jefferywex

6 days, 5 hours

buy prescription drugs online without <a href=" https://withoutprescription.store/# ">online prescription for ed meds</a>

Thomasassex

6 days, 6 hours

prescription drugs without doctor approval <a href=" https://withoutprescription.store/# ">best ed pills non prescription</a> https://cipro.best/# cipro ciprofloxacin [url=https://cipro.best/#]where can i buy cipro online[/url] cipro

Jeffreygob

6 days, 7 hours

prescription meds without the prescriptions <a href=" https://withoutprescription.store/# ">best canadian online pharmacy</a> https://withoutprescription.store/# canadian drug pharmacy [url=https://gabapentin.icu/#]neurontin prices generic[/url] buy generic neurontin

Andrewusevy

6 days, 11 hours

diflucan generic price <a href=" https://diflucan.icu/# ">diflucan online purchase</a> https://withoutprescription.store/# buy anti biotics without prescription [url=https://erectionpills.best/#]erection pills that work[/url] medicine for impotence

Michealdug

6 days, 15 hours

[url=https://withoutprescription.store/#]dog antibiotics without vet prescription[/url] mexican pharmacy without prescription

Andrewusevy

6 days, 16 hours

ed treatment pills <a href=" https://erectionpills.best/# ">ed remedies</a> https://erectionpills.best/# new ed drugs [url=https://gabapentin.icu/#]generic neurontin cost[/url] neurontin pill

RobertEstib

6 days, 20 hours

https://cipro.best/# cipro pharmacy

Jefferywex

6 days, 21 hours

buy cheap prescription drugs online <a href=" https://withoutprescription.store/# ">canadian drugs</a>

Thomasassex

https://buylipitor.store/# generic lipitor cost

Williamoffer

1 week, 1 day

tamoxifen buy <a href=" https://buynolvadex.store/# ">tamoxifen for breast cancer prevention</a>

Anthonyres

1 week, 1 day

https://buylasix.icu/# lasix furosemide 40 mg

PhilipDiume

1 week, 1 day

lasix generic name <a href=" https://buylasix.icu/# ">lasix 100 mg tablet</a> https://buytadalafil.men/# tadalafil capsules 21 mg [url=https://buynolvadex.store/#]nolvadex 10mg[/url] tamoxifen for breast cancer prevention

Raymondjuimi

1 week, 1 day

https://buylipitor.store/# how much is lipitor

Edwardhob

1 week, 2 days

best tadalafil tablets in india <a href=" https://buytadalafil.men/# ">generic cialis tadalafil uk</a>

Williamoffer

1 week, 2 days

metformin 850 mg cost <a href=" https://buymetformin.best/# ">metformin 1000 tablet</a>

Anthonyres

1 week, 2 days

https://buylipitor.store/# buy lipitor with mastercard

Raymondjuimi

1 week, 2 days

https://buynolvadex.store/# effexor and tamoxifen

Edwardhob

1 week, 2 days

buy lasix online <a href=" https://buylasix.icu/# ">lasix furosemide</a>

Raymondjuimi

1 week, 2 days

https://buytadalafil.men/# where to buy tadalafil in usa

HomerBic

zithromax 250 <a href=" https://zithromaxforsale.shop/# ">zithromax 500 mg lowest price drugstore online</a> https://doxycyclineforsale.life/# doxycycline for sale [url=https://amoxilforsale.best/#]amoxicillin discount[/url] where can you get amoxicillin

RobertChiLs

1 week, 5 days

zithromax 500 mg <a href=" https://zithromaxforsale.shop/# ">buy zithromax no prescription</a>

Rickytub

1 week, 5 days

[url=https://doxycyclineforsale.life/#]doxycycline capsules india[/url] buying doxycycline online

Georgesoits

1 week, 5 days

buy amoxicillin <a href=" https://amoxilforsale.best/# ">where to buy amoxicillin</a>

StephenErorK

1 week, 5 days

https://clomidforsale.life/# clomid 100mg purchase

Georgesoits

1 week, 5 days

zithromax buy online <a href=" https://zithromaxforsale.shop/# ">zithromax online</a>

StephenErorK

1 week, 6 days

https://prednisoneforsale.store/# prednisone 10 mg tablet cost

Shelbyfraub

1 week, 6 days

[url=https://prednisoneforsale.store/#]where can i buy prednisone without a prescription[/url] generic prednisone for sale

Georgesoits

1 week, 6 days

2 weeks, 4 days

It's in reality a great and useful piece of info. I am satisfied that you simply shared this helpful information with us. Please keep us up to date like this. Thanks for sharing.cheap nfl jerseyshttp://ariellaymyb.mee.nu/?entry=3383025https://fygbhmyqy1.exblog.jp/31523954/

icuovox

2 weeks, 4 days

[url=http://slkjfdf.net/]Ocayzoy[/url] <a href="http://slkjfdf.net/">Uciuvej</a> tgx.aoyo.djangocircle.com.mba.ks http://slkjfdf.net/

MichaelPamed

[url=https://drwithoutdoctorprescription.online/#]canadian drugs online[/url] canadian drugs

Ralphpoele

3 weeks, 3 days

Cameronwhoge

3 weeks, 4 days

pet meds without vet prescription canada <a href=" https://drwithoutdoctorprescription.online/# ">prescription drugs</a>

Abasytap

3 weeks, 6 days

orlistat constipation <a href="https://mxorlistat.com/">orlistat xenical alli</a> pastillas lindeza orlistat

Strompiomy

4 weeks

[url=https://stromectolgf.com/#]buy ivermectin online[/url] stromectol online pharmacy

Excuff

4 weeks

priligy pills uk <a href="https://priligydapoxetinetop.com/">priligy pills</a> dapoxetine hydrochloride 30 mg

Strompiomy

4 weeks, 1 day

[url=https://stromectolgf.online/#]ivermectin lice[/url] ivermectin generic

Iverslelp

1 month

ivermectin brand <a href=" https://stromectolgf.online/# ">cost of ivermectin medicine</a>

Chesterrot

1 month

https://stromectolgf.com/# cost of ivermectin

Iverslelp

1 month

ivermectin lotion price <a href=" https://stromectolgf.com/# ">generic ivermectin</a>

Strompiomy

ivermectin oral 0 8 <a href=" https://stromectolgf.online/# ">ivermectin cost uk</a>

Ephete

1 month

bimatoprost timolol <a href="https://bimatoprostonlines.com/">bimatoprost solution</a> bimatoprost ophthalmic solution for sale

HomerBic

1 month

cialis on ebay <a href=" https://tadalafilusi.com/# ">generic tadalafil 20mg india</a> cialis and pay pal

VernoningEp

cost of finasteride <a href=" https://finasteridemen.com/# ">finasteride without prescription</a> propecia 5 mg for sale

Quapprer

1 month, 3 weeks

viagra connect usa <a href="https://edviagrarx.com/">natural viagra recipe</a> viagra without a prescription

Quapprer

1 month, 3 weeks

1 month, 4 weeks

how long does it take cialis to work <a href=" https://cialismrt.com/# ">cialis usa</a> cialis pills australia

Williamavoiz

1 month, 4 weeks

stromectol 3 mg tablet price <a href=" https://stromectolmrt.com/# ">ivermectin tablets price</a> ivermectin for goats tractor supply

Boussy

1 month, 4 weeks

ingrediants in viagra <a href="https://viagracine.com/">viagra prescription</a> super viagra

Boussy

1 month, 4 weeks

200 mg viagra <a href="https://viagracine.com/">levitra vs viagra</a> generic viagra for sale

xvnjch

1 month, 4 weeks

hydroxychoroquin https://keys-chloroquinehydro.com/

Williamavoiz

1 month, 4 weeks

how to get prednisone tablets <a href=" https://prednisonemrt.com/# ">buy prednisone</a> 15 mg prednisone daily

utenna

1 month, 4 weeks

where to buy viagra <a href="https://myviagrabest.com/">best price for viagra 100mg</a> viagra spider

utenna

1 month, 4 weeks

viagra canadian pharmacy ezzz <a href="https://myviagrabest.com/">sildenafil 100</a> viagra generic over the counter

Williamavoiz

1 month, 4 weeks

best ed treatment <a href=" https://cheapdrugsmrt.online/# ">cure for ed</a> male ed pills

pinincox

1 month, 4 weeks

sildenafil over the counter <a href="https://viagrauniv.org/">viagra best buy</a> viagra otc

Jeffreybed

Charleswar

2 months

<a href=" https://stromectol.company/# ">stromectol for pinworms</a> ivermectin for cats dewormer

encome

2 months

cialis medication <a href="https://cialiskitch.com/">does cialis work</a> when should i take cialis

encome

2 months

cialis <a href="https://cialiskitch.com/">does cialis work</a> does cialis make you bigger

smoono

2 months

viagra government funded <a href="https://viagravill.com/">instant natural viagra</a> canadian pharmacy sildenafil

smoono

2 months

buy viagra online <a href="https://viagravill.com/">roman viagra</a> roman sildenafil

Stacyliz

2 months

best way to treat ed <a href=" http://cheapdrugs.best/# ">pumps for ed</a> how can i order prescription drugs without a doctor

Stacyliz

2 months

best medication for ed <a href=" http://cheapdrugs.best/# ">legal to buy prescription drugs from canada</a> natural ed cures

Dourajot

2 months

vardenafil zhewitra 20 <a href="https://levitrashot.org/">is levitra generic</a> auvitra vardenafil tablets

Stacyliz

fast ed meds online <a href=" http://drugsen.site/# ">best ed treatment</a> erectile dysfunction pills

triall

online pharmacy ezzz viagra <a href="https://meloveviagra.com/">sildenafil 20 mg cost</a> 200 milligram viagra

FrankNurse

prednisone online sale <a href=" http://prednisoneen.store/# ">prednisone 100 mg</a> prednisone 2 mg daily

Apogigo

3 months, 3 weeks

3 months, 3 weeks

3 months, 4 weeks

http://bitly.com/legenda-destan-vse-serii

gvhhnvrhnm

3 months, 4 weeks

Django Circle | How to integrate stackdriver logging with django web application? gvhhnvrhnm http://www.gq99j116e9q14hvgs216bfz3ls4p06k5s.org/ <a href="http://www.gq99j116e9q14hvgs216bfz3ls4p06k5s.org/">agvhhnvrhnm</a> [url=http://www.gq99j116e9q14hvgs216bfz3ls4p06k5s.org/]ugvhhnvrhnm[/url]

anusizetu

4 months

[url=http://slkjfdf.net/]Ujepuakid[/url] <a href="http://slkjfdf.net/">Ajucekoz</a> nrp.acdc.djangocircle.com.kdb.ld http://slkjfdf.net/

ofjxevekcp

4 months

Django Circle | How to integrate stackdriver logging with django web application? <a href="http://www.gur9691vv4exh876v4hiuvs8cq986327s.org/">aofjxevekcp</a> [url=http://www.gur9691vv4exh876v4hiuvs8cq986327s.org/]uofjxevekcp[/url] ofjxevekcp http://www.gur9691vv4exh876v4hiuvs8cq986327s.org/

AbrtNew

4 months

Дивитись фільм Бетмен <a href="http://bitly.com/betmen-2022-film">Бетмен 1989 дивитися онлайн</a> Бетмен дивитися онлайн

oveotlylf

4 months

Django Circle | How to integrate stackdriver logging with django web application? <a href="http://www.g633rk98lh13l29futp7r9750fo8b9dss.org/">aoveotlylf</a> [url=http://www.g633rk98lh13l29futp7r9750fo8b9dss.org/]uoveotlylf[/url] oveotlylf http://www.g633rk98lh13l29futp7r9750fo8b9dss.org/

gqxlkpd

[url=http://slkjfdf.net/]Iwuleguf[/url] <a href="http://slkjfdf.net/">Uhopidizi</a> mfq.cvfv.djangocircle.com.xwp.qs http://slkjfdf.net/

ubalebe

[url=http://slkjfdf.net/]Xaqenumop[/url] <a href="http://slkjfdf.net/">Iwejamax</a> dfu.wbab.djangocircle.com.ogp.mm http://slkjfdf.net/