mist-miner

README

mist-miner

Mining cloud resource usage

Usage

Build main cli

go build -o mist-miner

Execution

# Fetch cloud resource records
./mist-miner mine

# Show given hash object file content
./mist-miner cat-file <group> <hash>

gRPC build

protoc --go_out=. --go_opt=paths=source_relative \
    --go-grpc_out=. --go-grpc_opt=paths=source_relative,require_unimplemented_servers=false \
    proto/miner.proto

zlib uncompress

Use CLI to uncompress zlib file for viewing content

zlib-flate -uncompress < input_file_path

Note

Plugins

Plugins are responsible for returning consistent data when there are no changes to the resource. The shared library offers a JsonNormalize helper function that normalizes input JSON strings by sorting the keys of each object. Additionally, the MinerProperty struct includes a FormatContentValue method, which formats the data either as a normalized JSON string or as a regular string.

Example

property := shared.MinerProperty{
	Type: userDetail,
	Label: shared.MinerPropertyLabel{
		Name:   "UserDetail",
		Unique: true,
	},
	Content: shared.MinerPropertyContent{
		Format: shared.FormatJson,
	},
}
if err := property.FormatContentValue(ud.configuration.User); err != nil {
	return properties, fmt.Errorf("generate user detail: %w", err)
}

Documentation

Overview

Copyright © 2024 Min-Haw, Liu liuminhaw@gmail.com

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.