IoT SiteWise processor - AWS IoT Greengrass

IoT SiteWise processor

The IoT SiteWise processor component (aws.iot.SiteWiseEdgeProcessor) enables AWS IoT SiteWise gateways to process data at the edge.

With this component, AWS IoT SiteWise gateways can use asset models and assets to process data on gateway devices. For more information about AWS IoT SiteWise gateways, see Using AWS IoT SiteWise at the edge in the AWS IoT SiteWise User Guide.

Versions

This component has the following versions:

  • 2.1.x

  • 2.0.x

Type

This component is a generic component (aws.greengrass.generic). The Greengrass nucleus runs the component's lifecycle scripts.

For more information, see Component types.

Operating system

This component can be installed on core devices that run the following operating systems:

  • Linux

  • Windows

Requirements

This component has the following requirements:

  • The Greengrass core device must run on one of the following platforms:

    • OS: Ubuntu 20.04 or 18.04

      Architecture: x86_64 (AMD64)

    • OS: Red Hat Enterprise Linux (RHEL) 8

      Architecture: x86_64 (AMD64)

    • OS: Amazon Linux 2

      Architecture: x86_64 (AMD64)

    • OS: Windows Server 2019 or later

      Architecture: x86_64 (AMD64)

  • The Greengrass core device must allow inbound traffic on port 443.

  • The Greengrass core device must allow outbound traffic on port 443 and 8883.

  • The following ports are reserved for use by AWS IoT SiteWise: 80, 443, 3001, 4569, 4572, 8000, 8081, 8082, 8084, 8085, 8086, 8445, 9000, 9500, 11080, and 50010. Using a reserved port for traffic can result in a terminated connection.

    Note

    Port 8087 is required only for version 2.0.15 and later of this component.

  • The Greengrass device role must have permissions that allow you to use AWS IoT SiteWise gateways on your AWS IoT Greengrass V2 devices. For more information, see Requirements in the AWS IoT SiteWise User Guide.

Endpoints and ports

This component must be able to perform outbound requests to the following endpoints and ports, in addition to endpoints and ports required for basic operation. For more information, see Allow device traffic through a proxy or firewall.

Endpoint Port Required Description

model.iotsitewise.region.amazonaws.com

443 Yes

Get information about your AWS IoT SiteWise assets and asset models.

edge.iotsitewise.region.amazonaws.com

443 Yes

Get information about the core device's AWS IoT SiteWise gateway configuration.

ecr.region.amazonaws.com

443 Yes

Download AWS IoT SiteWise Edge gateway Docker images from Amazon Elastic Container Registry.

iot.region.amazonaws.com

443 Yes

Get device endpoints for your AWS account.

sts.region.amazonaws.com

443 Yes

Get the ID of your AWS account.

monitor.iotsitewise.region.amazonaws.com

443 No

Required if you access AWS IoT SiteWise Monitor portals on the core device.

Dependencies

When you deploy a component, AWS IoT Greengrass also deploys compatible versions of its dependencies. This means that you must meet the requirements for the component and all of its dependencies to successfully deploy the component. This section lists the dependencies for the released versions of this component and the semantic version constraints that define the component versions for each dependency. You can also view the dependencies for each version of the component in the AWS IoT Greengrass console. On the component details page, look for the Dependencies list.

The following table lists the dependencies for versions 2.0.x to 2.1.x of this component.

Dependency Compatible versions Dependency type
Token exchange service >=2.0.3 <3.0.0 Hard
Stream manager >=2.0.10 <3.0.0 Hard
Greengrass CLI >=2.3.0 <3.0.0 Hard

For more information about component dependencies, see the component recipe reference.

Configuration

This component doesn't have any configuration parameters.

Local log file

This component uses the following log file.

Linux
/greengrass/v2/logs/aws.iot.SiteWiseEdgeProcessor.log
Windows
C:\greengrass\v2\logs\aws.iot.SiteWiseEdgeProcessor.log

To view this component's logs

  • Run the following command on the core device to view this component's log file in real time. Replace /greengrass/v2 or C:\greengrass\v2 with the path to the AWS IoT Greengrass root folder.

    Linux
    sudo tail -f /greengrass/v2/logs/aws.iot.SiteWiseEdgeProcessor.log
    Windows (PowerShell)
    Get-Content C:\greengrass\v2\logs\aws.iot.SiteWiseEdgeProcessor.log -Tail 10 -Wait

Licenses

This component includes the following third-party software/licensing:

  • Apache-2.0

  • MIT

  • BSD-2-Clause

  • BSD-3-Clause

  • CDDL-1.0

  • CDDL-1.1

  • ISC

  • Zlib

  • GPL-3.0-with-GCC-exception

  • Public Domain

  • Python-2.0

  • Unicode-DFS-2015

  • BSD-1-Clause

  • OpenSSL

  • EPL-1.0

  • EPL-2.0

  • GPL-2.0-with-classpath-exception

  • MPL-2.0

  • CC0-1.0

  • JSON

This component is released under the Greengrass Core Software License Agreement.

Changelog

The following table describes the changes in each version of the component.

Version

Changes

2.1.24

Bug fixes and improvements
  • Fixes an issue that caused the dashboard to disappear when syncing a resource for the second time.

2.1.23

Bug fixes and improvements
  • Added a timeout for the aws.iot.SiteWiseEdgeProcessor install process to avoid installation failure if internet connectivity is slow.

  • Optimized resource sync to improve sync efficiency between the cloud and edge.

2.1.21

Warning

Upgrading from 2.0.x to 2.1.x will result in loss of local data.

New features
  • Adds support for Windows Server 2019 or higher.

  • Removes docker for Linux-based operating systems.

2.0.16

This version contains bug fixes and improvements.

2.0.15

Bug fixes and improvements
  • Changes the port that this component uses for resource sync API operations from 8085 to 8087. As a result, this component now requires port 8087 to be available. This component still requires port 8085 to be available.

  • Updates AWS OpsHub authentication to deny unauthorized users during login instead of when a user attempts to call API operations.

2.0.14

This version contains bug fixes and improvements.

2.0.13

Bug fixes and improvements
  • Fixes an issue so that when this component reports data to Amazon CloudWatch metrics, it now correctly indicates which data is unmodeled.

2.0.9

Bug fixes and improvements
  • Improves reliability to create and update AWS IoT SiteWise resources on the core device.

  • Adds additional local API operations that you can use to monitor which components are installed on the core device, the version of each component, and the status of each component. You can view this information on the Settings tab in the AWS OpsHub for AWS IoT SiteWise application on the core device.

  • Adds a health status for the Docker containers that this component runs. You can run the docker ps command to view the containers' health status.

2.0.7

Bug fixes and improvements
  • Fixes support for viewing AWS IoT SiteWise Monitor portals on the core device.

2.0.6

Bug fixes and improvements
  • Fixes the AWS IoT SiteWise statetime(), earliest(), and latest() functions that this component computes on the core device.

2.0.5

Bug fixes and improvements
  • Adds support for the AWS IoT SiteWise pretrigger() function in transforms that this component computes on the core device.

  • Changes the path where this component stores the Lightweight Directory Access Protocol (LDAP) configuration for authentication.

2.0.2

Initial version.

See also