Skip to content

Latest commit

 

History

History
76 lines (67 loc) · 3.12 KB

README.md

File metadata and controls

76 lines (67 loc) · 3.12 KB
Raw

GO QR Generator

GO QR Generator, is exactly what it sounds like; a QR code generator written in GoLang. Specifically, this is a small, simple microservice which will generate a QR code upon request - currently this microservice supports two client defined parameters:

  • data: (Required) The (URL encoded) string of data that should be encoded in the QR code.
  • size: (Optional) The size of the image (default configurable via arguments).

Example of request: Spin up the microservice, and go to http://localhost:8081/?size=350&data=This%20is%20a%20test

  • (If you wanted to do this from a command line, then install viu + curl and run curl http://localhost:8081/\?size\=350\&data\=This%20is%20a%20test -s | viu -!)

Public Endpoint: https://qr-api.ashleyprimo.com/docs

Usage of ./go-qr-generator:
  -enable.docs
    	Enable documentation (/docs) endpoint. (default true)
  -enable.metrics
    	Enable metrics (/metrics) endpoint. (default true)
  -enable.metrics.server
    	Enable seperate metrics server
  -host string
    	The host/address to listen on for HTTP requests. (default "0.0.0.0")
  -https
    	Enable, or Disable HTTPS
  -log.conn
    	Log connections to API (default true)
  -log.level string
    	The level of logs to log (default "info")
  -metrics.server.host string
    	The host/address to listen on for metrics HTTP requests. (default "0.0.0.0")
  -metrics.server.port string
    	The port number to listen on for metrics HTTP requests. (default "9100")
  -port string
    	The port number to listen on for HTTP requests. (default "8080")
  -qr.default.size int
    	Default QR Image Size, if unspecified by end user. (default 250)
  -qr.endpoint string
    	QR API endpoint location (default "/")
  -qr.max.size int
    	Maximum QR Image Size (default 1000)
  -server_crt string
    	Certificate file (default "server.crt")
  -server_key string
    	Certificate key file. (default "server.key")
  -v	Outputs package version

Endpoints

  • / -> API endpoint.
  • /docs -> Simple API documentation
  • /health -> Simple Health Check
  • /metrics -> Prometheus Metrics Endpoint

Metrics

Current available metrics

# HELP qr_generator_requests Completed requests to QR API endpoint.
# TYPE qr_generator_requests counter
qr_generator_requests{type="2xx"} 0
qr_generator_requests{type="4xx"} 0
qr_generator_requests{type="5xx"} 0
# HELP qr_generator_requests_total Total number of requests to QR API endpoint.
# TYPE qr_generator_requests_total counter
qr_generator_requests_total 0
# HELP qr_generator_version current running version
# TYPE qr_generator_version gauge
qr_generator_version{version="1.1.0"} 0

Docker

You can get started with docker quickly, by using the docker pull ashleyprimo/go-qr-generator:latest or alternatively you can build your own image using docker build ./ -t go-qr-generator:latest

Once you have pulled the image, you can now docker run ashleyprimo/go-qr-generator. That's it.

References