Skip to content

Commit 2d6b00a

Browse files
zeroc0d3zeroc0d3
committed
Update documentation & change log version
1 parent a02cc1b commit 2d6b00a

File tree

5 files changed

+144
-108
lines changed

5 files changed

+144
-108
lines changed

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,6 @@ test/**
7878

7979
*.db
8080

81-
dynamodb-golang-adot*
81+
dynamodb-golang-adot*
82+
*.tar.gz
83+
*.tgz

‎CHANGELOG.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)
44

5-
![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src) ![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot) ![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver) [![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/) ![download all](https://img.shields.io/github/downloads/devopscorner/golang-adot/total.svg) ![download latest](https://img.shields.io/github/downloads/devopscorner/golang-adot/0.1/total) ![view](https://views.whatilearened.today/views/github/devopscorner/golang-adot.svg) ![clone](https://img.shields.io/badge/dynamic/json?color=success&label=clone&query=count&url=https://github.com/devopscorner/golang-adot/blob/master/clone.json?raw=True&logo=github) ![issues](https://img.shields.io/github/issues/devopscorner/golang-adot) ![pull requests](https://img.shields.io/github/issues-pr/devopscorner/golang-adot) ![forks](https://img.shields.io/github/forks/devopscorner/golang-adot) ![stars](https://img.shields.io/github/stars/devopscorner/golang-adot) [![license](https://img.shields.io/github/license/devopscorner/golang-adot)](https://img.shields.io/github/license/devopscorner/golang-adot)
5+
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src) [![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/graphs/contributors) [![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)](https://github.com/devopscorner/golang-adot/releases) [![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/) ![download all](https://img.shields.io/github/downloads/devopscorner/golang-adot/total.svg) ![view](https://views.whatilearened.today/views/github/devopscorner/golang-adot.svg) ![clone](https://img.shields.io/badge/dynamic/json?color=success&label=clone&query=count&url=https://github.com/devopscorner/golang-adot/blob/master/clone.json?raw=True&logo=github) [![issues](https://img.shields.io/github/issues/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/issues) [![pull requests](https://img.shields.io/github/issues-pr/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/pulls) [![forks](https://img.shields.io/github/forks/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/fork) [![stars](https://img.shields.io/github/stars/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/stargazers) [![license](https://img.shields.io/github/license/devopscorner/golang-adot)](https://img.shields.io/github/license/devopscorner/golang-adot)
66

77
---
88

@@ -36,6 +36,20 @@ ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API
3636

3737
---
3838

39+
### version 1.1.4
40+
41+
- Update docker-compose configuration for `golang-adot`
42+
- Update Postman Collection for testing `golang-adot`
43+
- Update helm template for stateful services
44+
- Update script for added pre-requirements EKS-Cluster & Monitoring
45+
- Added Grafana Dashboard in `script` folder
46+
- Refactoring Golang-Adot with additional features:
47+
- Prometheus
48+
- Tracing Otel (OpenTelemetry)
49+
- Tracing XRay
50+
51+
---
52+
3953
### version 0.1
4054

4155
- First release for Golang Bookstore ADOT (AWS Distro for OpenTelemetry)

‎Makefile‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ codebuild-modules:
133133
@echo " Task : Get CodeBuild Modules "
134134
@echo " Date/Time : `date` "
135135
@echo "============================================================"
136+
@echo "./get-modules-codebuild.sh"
136137
@./get-modules-codebuild.sh
137138

138139
# ==================== #
@@ -144,6 +145,7 @@ git-clone:
144145
@echo " Task : Clone Repository Sources "
145146
@echo " Date/Time : `date`"
146147
@echo "================================================="
148+
@echo "./git-clone.sh $(SOURCE) $(TARGET)"
147149
@sh ./git-clone.sh $(SOURCE) $(TARGET)
148150
@echo '- DONE -'
149151

@@ -157,6 +159,7 @@ dockerhub-build-alpine:
157159
@echo " Task : Create Container GO-APP Alpine Image "
158160
@echo " Date/Time : `date`"
159161
@echo "========================================================"
162+
@echo "./dockerhub-build.sh Dockerfile $(CI_PATH) alpine ${ALPINE_VERSION}"
160163
@sh ./dockerhub-build.sh Dockerfile $(CI_PATH) alpine ${ALPINE_VERSION}
161164

162165
# ./ecr-build.sh [AWS_ACCOUNT] Dockerfile [ECR_PATH] [alpine] [version|latest|tags] [custom-tags]
@@ -165,6 +168,7 @@ ecr-build-alpine:
165168
@echo " Task : Create Container GO-APP Alpine Image "
166169
@echo " Date/Time : `date`"
167170
@echo "========================================================"
171+
@echo "./ecr-build.sh $(ARGS) Dockerfile $(CI_PATH) alpine ${ALPINE_VERSION}"
168172
@sh ./ecr-build.sh $(ARGS) Dockerfile $(CI_PATH) alpine ${ALPINE_VERSION}
169173

170174
# ========================= #
@@ -177,6 +181,7 @@ dockerhub-tag-alpine:
177181
@echo " Task : Set Tags Image Alpine to DockerHub"
178182
@echo " Date/Time : `date`"
179183
@echo "========================================================"
184+
@echo "./dockerhub-tag.sh $(CI_PATH) alpine ${ALPINE_VERSION}"
180185
@sh ./dockerhub-tag.sh $(CI_PATH) alpine ${ALPINE_VERSION}
181186

182187
# ./ecr-tag.sh [AWS_ACCOUNT] [ECR_PATH] [alpine|codebuild] [version|latest|tags] [custom-tags]
@@ -185,6 +190,7 @@ ecr-tag-alpine:
185190
@echo " Task : Set Tags Image Alpine to ECR"
186191
@echo " Date/Time : `date`"
187192
@echo "========================================================"
193+
@echo "./ecr-tag.sh $(ARGS) $(CI_PATH) alpine ${ALPINE_VERSION}"
188194
@sh ./ecr-tag.sh $(ARGS) $(CI_PATH) alpine ${ALPINE_VERSION}
189195

190196
# ========================= #
@@ -197,11 +203,13 @@ dockerhub-push-alpine:
197203
@echo " Task : Push Image Alpine to DockerHub"
198204
@echo " Date/Time : `date`"
199205
@echo "========================================================"
206+
@echo "./dockerhub-push.sh $(CI_PATH) alpine"
200207
@sh ./dockerhub-push.sh $(CI_PATH) alpine
201208

202209
ecr-push-alpine:
203210
@echo "========================================================"
204211
@echo " Task : Push Image Alpine to ECR"
205212
@echo " Date/Time : `date`"
206213
@echo "========================================================"
214+
@echo "./ecr-push.sh $(ARGS) $(CI_PATH) alpine"
207215
@sh ./ecr-push.sh $(ARGS) $(CI_PATH) alpine

‎README.md‎

Lines changed: 71 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)
44

5-
![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
6-
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
7-
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
5+
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
6+
[![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/graphs/contributors)
7+
[![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)](https://github.com/devopscorner/golang-adot/releases)
88
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
99
![download all](https://img.shields.io/github/downloads/devopscorner/golang-adot/total.svg)
10-
![download latest](https://img.shields.io/github/downloads/devopscorner/golang-adot/0.1/total)
10+
![download latest](https://img.shields.io/github/downloads/devopscorner/golang-adot/1.1.4/total)
1111
![view](https://views.whatilearened.today/views/github/devopscorner/golang-adot.svg)
1212
![clone](https://img.shields.io/badge/dynamic/json?color=success&label=clone&query=count&url=https://github.com/devopscorner/golang-adot/blob/master/clone.json?raw=True&logo=github)
13-
![issues](https://img.shields.io/github/issues/devopscorner/golang-adot)
14-
![pull requests](https://img.shields.io/github/issues-pr/devopscorner/golang-adot)
15-
![forks](https://img.shields.io/github/forks/devopscorner/golang-adot)
16-
![stars](https://img.shields.io/github/stars/devopscorner/golang-adot)
13+
[![issues](https://img.shields.io/github/issues/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/issues)
14+
[![pull requests](https://img.shields.io/github/issues-pr/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/pulls)
15+
[![forks](https://img.shields.io/github/forks/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/fork)
16+
[![stars](https://img.shields.io/github/stars/devopscorner/golang-adot)](https://github.com/devopscorner/golang-adot/stargazers)
1717
[![license](https://img.shields.io/github/license/devopscorner/golang-adot)](https://img.shields.io/github/license/devopscorner/golang-adot)
1818

1919
---
@@ -63,56 +63,58 @@ ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API
6363
## GO Repository Pattern
6464

6565
- Folder Structure
66-
```
67-
.
68-
├── .env
69-
├── .env.example
70-
├── config
71-
│   ├── config.go
72-
│   ├── config_test.go
73-
│   ├── const.go
74-
│   ├── logger.go
75-
│   └── value.go
76-
├── controller
77-
│   ├── book_controller.go
78-
│   ├── book_controller_test.go
79-
│   ├── login_controller.go
80-
│   └── login_controller_test.go
81-
├── driver
82-
│   ├── db.go
83-
│   ├── dynamo.go
84-
│   ├── mysql.go
85-
│   ├── psql.go
86-
│   └── sqlite.go
87-
├── dynamodb-golang-adot
88-
├── go.mod
89-
├── go.sum
90-
├── main.go
91-
├── main_test.go
92-
├── middleware
93-
│   ├── auth_middleware.go
94-
│   └── auth_middleware_test.go
95-
├── migrate_book.go.example
96-
├── migrate_book_dynamo.go.example
97-
├── model
98-
│   └── book.go
99-
├── observability
100-
│   ├── metrics.go
101-
│   ├── provider.go
102-
│   └── xray.go
103-
├── repository
104-
│   └── book_repository.go
105-
├── routes
106-
│   ├── book_routes.go
107-
│   ├── main_routes.go
108-
│   └── telemetry_routes.go
109-
└── view
110-
├── book_view.go
111-
├── error_view.go
112-
└── login_view.go
113-
114-
10 directories, 36 files
115-
```
66+
67+
```
68+
.
69+
├── .env
70+
├── .env.example
71+
├── config
72+
│ ├── config.go
73+
│ ├── config_test.go
74+
│ ├── const.go
75+
│ ├── logger.go
76+
│ └── value.go
77+
├── controller
78+
│ ├── book_controller.go
79+
│ ├── book_controller_test.go
80+
│ ├── login_controller.go
81+
│ └── login_controller_test.go
82+
├── driver
83+
│ ├── db.go
84+
│ ├── dynamodb.go
85+
│ ├── mysql.go
86+
│ ├── psql.go
87+
│ └── sqlite.go
88+
├── go.mod
89+
├── go.sum
90+
├── main.go
91+
├── main_test.go
92+
├── middleware
93+
│ ├── auth_middleware.go
94+
│ └── auth_middleware_test.go
95+
├── migrate_book.go.example
96+
├── migrate_book_dynamo.go.example
97+
├── model
98+
│ └── book.go
99+
├── observability
100+
│ ├── metrics.go
101+
│ ├── provider.go
102+
│ ├── tracing-otel.go
103+
│ └── tracing-xray.go
104+
├── repository
105+
│ └── book_repository.go
106+
├── routes
107+
│ ├── book_routes.go
108+
│ ├── main_routes.go
109+
│ ├── telemetry_routes.go
110+
│ └── tracing_routes.go
111+
└── view
112+
├── book_view.go
113+
├── error_view.go
114+
└── login_view.go
115+
116+
10 directories, 37 files
117+
```
116118

117119
## Coverages:
118120
### AWS Services
@@ -125,7 +127,7 @@ ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API
125127
- AWS Systems Manager Parameter Store
126128
- AWS Developer Tools (AWS CodeCommit, AWS CodePipeline, AWS CodeBuild)
127129
- Amazon EKS
128-
- Amazon OpenSearch
130+
- Amazon OpenSearch -- *(Optional)*
129131
- Amazon DynamoDB
130132

131133
### Others:
@@ -254,6 +256,16 @@ ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API
254256
9. Provisioning Resources Managed Services OpenSearch, detail [here](docs/reproduce-09-provisioning-resources-opensearch.md)
255257
10. Provisioning Resources EKS ADOT Collector, detail [here](docs/reproduce-10-provisioning-resources-eks-adot-collector.md)
256258
259+
## Snapshots
260+
261+
- Grafana Dashboard
262+
![golang-adot-001](./docs/assets/adot-001.png)
263+
![golang-adot-002](./docs/assets/adot-002.png)
264+
265+
- XRay
266+
![golang-adot-003](./docs/assets/adot-003.png)
267+
![golang-adot-004](./docs/assets/adot-004.png)
268+
257269
## Tested Environment
258270
259271
### Versioning

‎clone.json‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,81 @@
11
{
2-
"count": 2219,
3-
"uniques": 295,
2+
"count": 4478,
3+
"uniques": 377,
44
"clones": [
55
{
6-
"timestamp": "2023-04-25T00:00:00Z",
7-
"count": 107,
8-
"uniques": 61
6+
"timestamp": "2023-03-12T00:00:00Z",
7+
"count": 85,
8+
"uniques": 62
99
},
1010
{
11-
"timestamp": "2023-04-26T00:00:00Z",
12-
"count": 155,
13-
"uniques": 84
11+
"timestamp": "2023-03-13T00:00:00Z",
12+
"count": 316,
13+
"uniques": 145
1414
},
1515
{
16-
"timestamp": "2023-04-27T00:00:00Z",
17-
"count": 156,
18-
"uniques": 85
16+
"timestamp": "2023-03-14T00:00:00Z",
17+
"count": 282,
18+
"uniques": 137
1919
},
2020
{
21-
"timestamp": "2023-04-28T00:00:00Z",
22-
"count": 165,
23-
"uniques": 73
21+
"timestamp": "2023-03-15T00:00:00Z",
22+
"count": 318,
23+
"uniques": 152
2424
},
2525
{
26-
"timestamp": "2023-04-29T00:00:00Z",
27-
"count": 163,
28-
"uniques": 69
26+
"timestamp": "2023-03-16T00:00:00Z",
27+
"count": 316,
28+
"uniques": 155
2929
},
3030
{
31-
"timestamp": "2023-04-30T00:00:00Z",
32-
"count": 163,
33-
"uniques": 79
31+
"timestamp": "2023-03-17T00:00:00Z",
32+
"count": 332,
33+
"uniques": 133
3434
},
3535
{
36-
"timestamp": "2023-05-01T00:00:00Z",
37-
"count": 161,
38-
"uniques": 86
36+
"timestamp": "2023-03-18T00:00:00Z",
37+
"count": 344,
38+
"uniques": 135
3939
},
4040
{
41-
"timestamp": "2023-05-02T00:00:00Z",
42-
"count": 153,
43-
"uniques": 89
41+
"timestamp": "2023-03-19T00:00:00Z",
42+
"count": 370,
43+
"uniques": 155
4444
},
4545
{
46-
"timestamp": "2023-05-03T00:00:00Z",
47-
"count": 163,
48-
"uniques": 91
46+
"timestamp": "2023-03-20T00:00:00Z",
47+
"count": 337,
48+
"uniques": 153
4949
},
5050
{
51-
"timestamp": "2023-05-04T00:00:00Z",
52-
"count": 169,
53-
"uniques": 83
51+
"timestamp": "2023-03-21T00:00:00Z",
52+
"count": 322,
53+
"uniques": 152
5454
},
5555
{
56-
"timestamp": "2023-05-05T00:00:00Z",
57-
"count": 158,
58-
"uniques": 79
56+
"timestamp": "2023-03-22T00:00:00Z",
57+
"count": 308,
58+
"uniques": 140
5959
},
6060
{
61-
"timestamp": "2023-05-06T00:00:00Z",
62-
"count": 157,
63-
"uniques": 78
61+
"timestamp": "2023-03-23T00:00:00Z",
62+
"count": 305,
63+
"uniques": 143
6464
},
6565
{
66-
"timestamp": "2023-05-07T00:00:00Z",
67-
"count": 159,
68-
"uniques": 84
66+
"timestamp": "2023-03-24T00:00:00Z",
67+
"count": 306,
68+
"uniques": 133
6969
},
7070
{
71-
"timestamp": "2023-05-08T00:00:00Z",
72-
"count": 160,
73-
"uniques": 91
71+
"timestamp": "2023-03-25T00:00:00Z",
72+
"count": 306,
73+
"uniques": 128
7474
},
7575
{
76-
"timestamp": "2023-05-09T00:00:00Z",
77-
"count": 30,
78-
"uniques": 25
76+
"timestamp": "2023-03-26T00:00:00Z",
77+
"count": 231,
78+
"uniques": 123
7979
}
8080
]
8181
}

0 commit comments

Comments
 (0)