mirror of
https://github.com/nabbar/golib.git
synced 2026-04-22 23:17:12 +08:00
Nicolas JUHEL
2df3f4ccf8
- FIX missing info statement to expose in result - UPDATE documentation, test
95 lines
2.8 KiB
Go
95 lines
2.8 KiB
Go
/*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2022 Nicolas JUHEL
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
*
|
|
*/
|
|
|
|
package status
|
|
|
|
import (
|
|
"time"
|
|
|
|
libver "github.com/nabbar/golib/version"
|
|
)
|
|
|
|
// SetInfo manually sets the application information to be displayed in status responses.
|
|
// This method is a convenient way to provide static version details when the full
|
|
// `version` package integration is not needed or available.
|
|
//
|
|
// When using this method, the build date is automatically set to a zero time value,
|
|
// as it is not provided in the arguments.
|
|
//
|
|
// Parameters:
|
|
// - name: The name of the application or service (e.g., "MyAPI").
|
|
// - release: The version string (e.g., "v1.2.3", "1.0.0-beta").
|
|
// - hash: The build hash or commit identifier (e.g., "abc123def456").
|
|
//
|
|
// This method is thread-safe.
|
|
func (o *sts) SetInfo(name, release, hash string) {
|
|
o.m.Lock()
|
|
defer o.m.Unlock()
|
|
|
|
o.fn = func() string {
|
|
return name
|
|
}
|
|
|
|
o.fr = func() string {
|
|
return release
|
|
}
|
|
|
|
o.fh = func() string {
|
|
return hash
|
|
}
|
|
|
|
o.fd = func() time.Time {
|
|
return time.Time{}
|
|
}
|
|
}
|
|
|
|
// SetVersion sets the application information from a `version.Version` object.
|
|
// This is the recommended method for integrating with the `github.com/nabbar/golib/version`
|
|
// package, as it allows for dynamic updates to version information and includes
|
|
// the build timestamp.
|
|
//
|
|
// This method links the status system to the version object, automatically extracting
|
|
// the application name, release, build hash, and build time whenever the status
|
|
// is queried.
|
|
//
|
|
// Parameters:
|
|
// - v: The `version.Version` object containing the application's metadata.
|
|
//
|
|
// This method is thread-safe.
|
|
func (o *sts) SetVersion(v libver.Version) {
|
|
o.m.Lock()
|
|
defer o.m.Unlock()
|
|
|
|
if v == nil {
|
|
return
|
|
}
|
|
|
|
o.fn = v.GetPackage
|
|
o.fr = v.GetRelease
|
|
o.fh = v.GetBuild
|
|
o.fd = v.GetTime
|
|
}
|