Merge pull request #3 from chatwork/status-endpoint

Parse command line arguments

Author: ada-u

.circleci/config.yml

@@ -5,6 +5,12 @@ orbs:
   # https://circleci.com/developer/orbs/orb/circleci/go
   go: circleci/[email protected]
 
+executors:
+  docker_executor:
+    docker:
+      - image: chatwork/circleci-docker:18.09.3
+    working_directory: /root/project
+
 workflows:
   version: 2
   main:
@@ -13,6 +19,14 @@ workflows:
           filters:
             tags:
               only: /.*/
+      - docker_build_and_bush:
+          context: "DockerHub"
+          filters:
+            tags:
+              only: /^.*/
+            branches:
+              ignore:
+                - /^.*/
 
 jobs:
   go_build:
@@ -22,4 +36,17 @@ jobs:
     steps:
       - checkout
       - go/mod-download-cached
-      - run: make
+      - run: make
+
+  docker_build_and_bush:
+    executor: docker_executor
+    environment:
+      - CIRCLECI_WORKSPACE: /root/project
+    steps:
+      - checkout
+      - setup_remote_docker:
+          docker_layer_caching: true
+          version: 18.09.3
+      - run: docker login -u="${DOCKER_REGISTRY_USERNAME}" -p="${DOCKER_REGISTRY_PASSWORD}"
+      - run: make build-image
+      - run: make push-image

.gitignore

@@ -1,4 +1,4 @@
-exporter
+dist
 
 .env
 

Dockerfile

@@ -14,6 +14,5 @@ RUN apk --no-cache add ca-certificates \
      && adduser -S -G exporter exporter
 USER exporter
 COPY --from=build /bin/exporter /bin/exporter
-ENV LISTEN_PORT=2112
-EXPOSE 2112
+
 ENTRYPOINT [ "/bin/exporter" ]

Makefile

@@ -1,5 +1,23 @@
+USER     := ada-u
+REPO     := sendgrid-stats-exporter
+GIT_TAG  := $(shell git tag --points-at HEAD)
+GIT_HASH := $(shell git rev-parse HEAD)
+VERSION  := $(shell if [ -n "$(GIT_TAG)" ]; then echo "$(GIT_TAG)"; else echo "$(GIT_HASH)"; fi)
+
+DIST_DIR := $(shell if [ -n "$(GOOS)$(GOARCH)" ]; then echo "./dist/$(GOOS)-$(GOARCH)"; else echo "./dist"; fi)
+
 default: build
 
 .PHONY: build
 build:
-	go build -o exporter .
+	@echo "version: $(VERSION) hash: $(GIT_HASH) tag: $(GIT_TAG)"
+	go build -ldflags "-s -w -X main.version=$(VERSION) -X main.gitCommit=$(GIT_HASH)" -o $(DIST_DIR)/exporter .
+
+.PHONY: build-image
+build-image:
+	docker build -t chatwork/"$(REPO)" .
+	docker tag chatwork/"$(REPO)":latest chatwork/"$(REPO)":"$(VERSION)"
+
+.PHONY: push-image
+push-image:
+	docker push chatwork/"$(REPO)"

README.md

@@ -11,6 +11,60 @@
 
 ## Usage
 
+```
+$ make
+$ ./exporter --sendgrid.api-key='secret' --web.listen-address=':9154' --web.disable-exporter-metrics
+```
+
+```
+$ curl localhost:9154/-/healthy
+$ curl localhost:9154/metrics
+```
+
+```
+$ ./exporter -h
+usage: exporter [<flags>]
+
+Flags:
+  -h, --help                  Show context-sensitive help (also try --help-long and --help-man).
+      --web.listen-address=":9154"
+                              Address to listen on for web interface and telemetry.
+      --web.disable-exporter-metrics
+                              Exclude metrics about the exporter itself (promhttp_*, process_*, go_*).
+      --sendgrid.username=""  Set SendGrid username
+      --sendgrid.api-key="secret"
+                              Set SendGrid API key
+      --log.level=info        Only log messages with the given severity or above. One of: [debug, info, warn, error]
+      --log.format=logfmt     Output format of log messages. One of: [logfmt, json]
+      --version               Show application version.
+```
+
+## Endpoints
+
+Name     | Description
+---------|-------------
+`/metrics` | get metrics
+`/-/healthy` | for health check
+
+## Metrics
+
+Name     | Description
+---------|------------
+blocks | dummy
+bounce_drops | dummy
+bounces | dummy
+deferred | dummy
+delivered | dummy
+invalid_emails | dummy
+processed | dummy
+requests | dummy
+spam_report_drops | dummy
+spam_reports | dummy
+unique_clicks | dummy
+unique_opens | dummy
+unsubscribe_drops | dummy
+unsubscribes | dummy
+
 ### Running with Docker
 
 (TBW)
@@ -40,46 +94,3 @@ $ make
 ```
 $ docker build -t sendgrid-stats-exporter .
 ```
- 
-## Configuration
-
-### Exporter
-
-You can specify a user name as environment variable to identify metrics for multiple users, as well as categories. 
-
-Name     | Description | Default
----------|-------------|----
-`SENDGRID_API_KEY` | API key for calling stats API (v3) | `""`
-`SENDGRID_USER_NAME` | (Optional) Label for metrics | `""`
-`SENDGRID_CATEGORY` | (not implemented) | `""`
-
-### Prometheus
-
-Example:
-
-```yaml
-scrape_configs:
-  - job_name: 'sendgrid'
-    static_configs:
-      - targets:
-          -  https://sendgrid-stats-exporter.example.com:2112
-```
-
-## Metrics
-
-Name     | Description
----------|------------
-blocks | dummy
-bounce_drops | dummy
-bounces | dummy
-deferred | dummy
-delivered | dummy
-invalid_emails | dummy
-processed | dummy
-requests | dummy
-spam_report_drops | dummy
-spam_reports | dummy
-unique_clicks | dummy
-unique_opens | dummy
-unsubscribe_drops | dummy
-unsubscribes | dummy