feat: json struct tags for health.Info (#24)

loozhengyuan · Feb 24, 2021 · 67e9de6 · 67e9de6
1 parent b2a7558
commit 67e9de6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
 ### Added
 
 * Health checks now run asynchronously ([#22](https://github.com/loozhengyuan/grench/pull/22))
+* JSON struct tags for health.Info ([#24](https://github.com/loozhengyuan/grench/pull/24))
 
 <!-- END Unreleased -->
 

diff --git a/pkg/health/health.go b/pkg/health/health.go
@@ -34,19 +34,19 @@ func (s Status) String() string {
 // Info represents the outcome of a health check.
 type Info struct {
 	// Name of the component, e.g. database, network, etc.
-	Component string
+	Component string `json:"component,omitempty"`
 
 	// Health status of the component.
-	Status Status
+	Status Status `json:"status,omitempty"`
 
 	// Information on the health status.
-	Message string
+	Message string `json:"message,omitempty"`
 
 	// Timestamp when component was checked.
-	CheckedAt time.Time
+	CheckedAt time.Time `json:"checked_at,omitempty"`
 
 	// Metadata information about the component check.
-	Metadata map[string]string
+	Metadata map[string]string `json:"metadata,omitempty"`
 }
 
 // CheckFunc is a functional expression of a check procedure.