logging

README

EdgeX Foundry Support Logging Service

Support Logging provides a centralized logging facility for all EdgeX microservices. Logging service features a REST API for other micro services to add/query/delete logging requests. Two options of persistence--file or mongodb--are supported and are configurable.

Install and Deploy Native

Prerequisites

Serveral EdgeX Foundry services depend on ZeroMQ for communications by default. The easiest way to get and install ZeroMQ is to use or follow the following setup script: https://gist.github.com/katopz/8b766a5cb0ca96c816658e9407e83d00.

Note: Setup of the ZeroMQ library is not supported on Windows plaforms.

Installation and Execution

To fetch the code and build the microservice execute the following:

cd $GOPATH/src
go get github.com/Circutor/edgex
cd $GOPATH/src/github.com/Circutor/edgex
# pull the 3rd party / vendor packages
make prepare
# build the microservice
make cmd/support-logging/support-logging
# get to the support logging microservice executable
cd cmd/support-logging
# run the microservice (may require other dependent services to run correctly)
./support-logging

Community

• Chat: https://edgexfoundry.slack.com
• Mainling lists: https://lists.edgexfoundry.org/mailman/listinfo

License

Apache-2.0

Documentation

Overview

******************************************************************************

• Copyright 2018 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

Index

• Constants
• Variables
• func Destruct()
• func HttpServer() http.Handler
• func Init() bool
• func Retry(useProfile string, timeout int, wait *sync.WaitGroup, ch chan error)
• type ConfigurationStruct
• type WritableInfo

Constants

const (
	PersistenceDB   = "database"
	PersistenceFile = "file"
)

Variables

var LoggingClient logger.LoggingClient

Functions

func Destruct

func Destruct()

func HttpServer

func HttpServer() http.Handler

HTTPServer function

func Init

func Init() bool

func Retry

func Retry(useProfile string, timeout int, wait *sync.WaitGroup, ch chan error)

Types

type ConfigurationStruct

type ConfigurationStruct struct {
	Writable  WritableInfo
	Databases map[string]config.DatabaseInfo
	Logging   config.LoggingInfo
	Service   config.ServiceInfo
}

var Configuration *ConfigurationStruct

type WritableInfo

type WritableInfo struct {
	Persistence string
	LogLevel    string
}