data package - github.com/Circutor/edgex/internal/core/data

README ¶

EdgeX Foundry Core Data Service

Core Data provides a centralized persistence facility for data readings collected by devices and sensors. Device services for devices and sensors that collect data, call on the Core Data service to store the device and sensor data on the edge system (such as in a gateway) until the data can be moved "north" and then exported to Enterprise and cloud systems.

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/core-data/core-data
# get to the core data microservice executable
cd cmd/core-data
# run the microservice (may require other dependent services to run correctly)
./core-data

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. ******************************************************************************

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

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. ******************************************************************************

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

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. ******************************************************************************

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

Copyright 2017 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. ******************************************************************************

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

Copyright 2017 Dell Inc.
Copyright (c) 2019 Intel Corporation *
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. ******************************************************************************

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

Copyright 2017 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. ******************************************************************************

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

Copyright 2017 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 ¶

Variables
func Destruct()
func Init() bool
func LoadRestRoutes() *mux.Router
func Retry(useProfile string, timeout int, wait *sync.WaitGroup, ch chan error)
type ConfigurationStruct
type DeviceLastReported
type DeviceServiceLastReported
type WritableInfo

Constants ¶

This section is empty.

Variables ¶

View Source

var LoggingClient logger.LoggingClient

Functions ¶

func Destruct ¶

func Destruct()

func Init ¶

func Init() bool

func LoadRestRoutes ¶

func LoadRestRoutes() *mux.Router

func Retry ¶

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

Types ¶

type ConfigurationStruct ¶

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

var Configuration *ConfigurationStruct

Global variables

type DeviceLastReported ¶

type DeviceLastReported struct {
	DeviceName string
}

An event indicating that a given device has just reported some data

type DeviceServiceLastReported ¶

type DeviceServiceLastReported struct {
	DeviceName string
}

An event indicating that the service associated with the device that just reported data is alive.

type WritableInfo ¶

type WritableInfo struct {
	DeviceUpdateLastConnected  bool
	MetaDataCheck              bool
	PersistData                bool
	ServiceUpdateLastConnected bool
	LogLevel                   string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
errors ****************************************************************************** * Copyright 2018 Dell Inc.	****************************************************************************** * Copyright 2018 Dell Inc.
interfaces ****************************************************************************** * Copyright 2017 Dell Inc.	****************************************************************************** * Copyright 2017 Dell Inc.
mocks
messaging ****************************************************************************** * Copyright 2017 Dell Inc.	****************************************************************************** * Copyright 2017 Dell Inc.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL