Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application...

29
Troubleshooting © 2020 General Electric Company

Transcript of Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application...

Page 1: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Troubleshooting

© 2020 General Electric Company

Page 2: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Contents

Chapter 1: Administrator Troubleshooting 1Data Failed to Load Error 2

Text or Number Converted to Wrong Format 2

Chapter 2: Analysis Troubleshooting 4Assets or Child Tags Missing in the Search Result 5

Chapter 3: Analytics Troubleshooting 7Cannot Access Application Analytics Module and Apps 8

Cannot Access Application Analytics Module and/or Features 8

Cannot Access Custom Properties For Alerts in Analytic Output 9

Cannot Deploy an Analytic to Predix Runtime 9

Cannot Access Attributes in the Asset Filter 10

Failed Analytics Deployment 10

Chapter 4: Dashboards Troubleshooting 12Context Browser is Empty 13

Page Failed to Load During Navigation from Widget 13

Chapter 5: Ingestion Troubleshooting 14Troubleshoot Asset Ingestion Errors 15

Prolonged Ingestion Time 18

Error: Illegal Character ((CTRL-CHAR, code 0)) 19

Cannot See Ingested Time-series Data on Analysis Page 20

Cannot Edit Tag Instance Through REST Call 21

Error Ingesting Tags 22

Server Error Upon Updating a Tag Group 24

ii Troubleshooting

Page 3: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Copyright GE Digital© 2020 General Electric Company.

GE, the GE Monogram, and Predix are either registered trademarks or trademarks of All other trademarksare the property of their respective owners.

This document may contain Confidential/Proprietary information of and/or its suppliers or vendors.Distribution or reproduction is prohibited without permission.

THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS," WITH NO REPRESENTATION ORWARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TOWARRANTIES OF DESIGN, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHERLIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLYDISCLAIMED.

Access to and use of the software described in this document is conditioned on acceptance of the EndUser License Agreement and compliance with its terms.

© 2020 General Electric Company iii

Page 4: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features
Page 5: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Chapter

1Administrator TroubleshootingTopics:

• Data Failed to Load Error• Text or Number Converted to

Wrong Format

© 2020 General Electric Company 1

Page 6: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Data Failed to Load ErrorYou see the Data Failed to Load error after performing a contains search for asset or tag classificationswith less than three characters in the search text.

Condition

You log in to the APM application. You navigate to the Classifications page to search for asset or tagclassifications. You select the Contains search filter for one or more search criteria and provide a searchkeyword fewer than three characters (for example, tr or et). When no results are returned after aminute of searching, the error message Data failed to Load appears.

Cause

When you perform the search with multiple query options or fewer search characters, your search scopeis widened, impacting the query performance and leading to slower result retrieval.

Remedy

Try to perform the search again. Use three or more characters in your search text, adding more if neededto obtain the search results. For example, if you want to search for the Classification Names such as AssetTurbines, Asset LT X45, turbo-asset or jet-asset, then provide the search text asset instead of set or etto narrow your search results.

Text or Number Converted to Wrong Format

Condition

When you access a CSV file in Microsoft Excel or the Google Sheets application, text or number values (forexample, 42E002 or 430002) are automatically converted to an unintended number format (for example,4.20E+04 or 4.30E+04).

Cause

Microsoft Excel and Google Sheets automatically apply a scientific notation or exponential format to thecell, if the text in that cell contains the letter E in uppercase or lowercase letters, or the number contains acharacter length larger than the column width.

Remedy

If you use Microsoft Excel or Google Sheets to edit or create your csv file, you must perform these stepsbefore you type the numbers in the cells as text:

1. Access a new Excel file.2. Select File > Import.3. Select CSV file, then select Import.4. Browse for the downloaded file on your local hard drive.5. Select Get data.6. In the Original Data Type section, select Delimited, then select Next.7. In the Delimiters section, select Tab and Comma, then select Next.

2 © 2020 General Electric Company

Page 7: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

8. Select the column you want to format in the table, select Text from the Column data format options,then select Finish.

9. In the Import Data dialog box, select Existing sheet, then select OK.10. Save the Excel file to your local hard drive.

This method allows you to enter data in the selected cells as text. Make sure that the column width islarge enough to fit in the longest value in that column. This ensures that the cell value is not automaticallyconverted to another unintended format.

You can also use a plain text editor such as Notepad to modify your CSV file.

© 2020 General Electric Company 3

Page 8: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Chapter

2Analysis TroubleshootingTopics:

• Assets or Child Tags Missing inthe Search Result

4 © 2020 General Electric Company

Page 9: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Assets or Child Tags Missing in the Search ResultChild tags expected to match the search filter are not available to plot in the Analysis chart.

Condition

One or both of the following apply:

• You perform the task Plotting Child Tags to search for child tags within the context of the selectedenterprise, site, segment, or asset in the Context Browser. You expect to see more tags matching thesearch filter within the context of all children below the selected node (enterprise, site, segment orasset) up to the last leaf. However, the result does not include all tags matching the search criteria. Asa result, the tags unlisted cannot be plotted on the chart.

Note: When selecting an item returned from the Context Browser:

◦ If the result is an asset, the context is automatically set to the selected asset, and a new analysisappears.

◦ If the result is an enterprise, site, or segment, the context is automatically set to your selection.• You perform the steps "To add secondary assets to a chart" in the task Add and Remove Multiple

Assets. You expect to see assets within the context of the selected enterprise, site, segment, or assetin the Context Browser. However, the results do not include all child assets for the selected root node.You are unable to add required assets to search further for tags to plot in the chart.

Cause

In GE Digital APM, the asset configuration service stores tenant-specific transitive depth information.Unless explicitly changed during tenant setup, these values are set to the default shown in the followingcode sample:

{ "transitiveDepthConfig": { "enterprises": 1, "sites": 1, "segments": 1, "assets": 1 }}

This transitive depth determines how deep to query the hierarchy in child node searches such as the childtag search in the Analysis screen. If your tenant asset model has a depth greater than the default, thenthe search query returns results limited to the level matching the default. For example, if your tenant usesan asset hierarchy with two levels of segments and two levels of assets, but its transitive depthconfiguration is set to the default value of 1, then searching for assets or child tags from the top segmentnode does not include search results beyond the default depth.

Remedy

Contact support to change your transitive depth configuration to match the nodes in your hierarchy,allowing the child tag search to traverse to the last leaf node starting from the selected node. Click thefollowing link to enter a support ticket: http://www.ge.com/digital/support.

© 2020 General Electric Company 5

Page 10: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Verification

After the transitive depth configuration has been updated, perform the tasks Plotting Child Tags or Addand Remove Multiple Assets again to search for assets or tags. The search list shows results as expected.

6 © 2020 General Electric Company

Page 11: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Chapter

3Analytics TroubleshootingTopics:

• Cannot Access ApplicationAnalytics Module and Apps

• Cannot Access ApplicationAnalytics Module and/orFeatures

• Cannot Access CustomProperties For Alerts in AnalyticOutput

• Cannot Deploy an Analytic toPredix Runtime

• Cannot Access Attributes in theAsset Filter

• Failed Analytics Deployment

© 2020 General Electric Company 7

Page 12: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Cannot Access Application Analytics Module and AppsYou cannot access the Analytics module and apps in your tenant.

Condition

You are logged in to your tenant with the necessary privileges to access the Analytics module and apps.However, when you select any navigation links in the Analytics module, the following error messageappears: Your tenant provisioning is incomplete. Request your tenantAdministrator to create the analytic functional user in the Tenant.

Cause

Your tenant administrator has not set up the password for the analytic system user to enable theApplication Analytics to communicate with the configured runtime for your tenant.

Remedy

Perform the steps in Set Up the Analytics Functional User.

Cannot Access Application Analytics Module and/or FeaturesYou are not able to access some or all of Application Analytics modules, sub-modules, apps and featuresin your tenant.

Condition

You are logged in to your tenant, you have one or more of the following problems:

• You cannot access any sub-modules.• You can access but cannot make additions or modifications in the sub-module/app. For example, you

can access deployments, but cannot add new deployments or modify existing deployments.• You cannot access some of the sub-modules/apps. For example, you can view Analytics Templates and

Orchestrations, but cannot access Deployments or Asset Filters.

Cause

Your tenant administrator has not enabled access to the required permission sets to access theappropriate sub-modules/apps. Your tenant configuration may be older and still uses the wide defaultpermission set of Manage Analytics Catalog. It must be configured with the granular permission sets.

Remedy

Work with your tenant administrator to give you the needed permission sets to access the required sub-modules/Apps.

8 © 2020 General Electric Company

Page 13: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Cannot Access Custom Properties For Alerts in Analytic OutputYou cannot access the custom properties key-values pairs that were passed to GE Digital APM Alertsthrough an analytic output event.

Condition

The GE Digital APM alert service does not publish the custom properties passed through events in theanalytic output. The analytic had passed these custom properties as an array of key-value pairs in theanalytic output.

Cause

The related keys in custom properties of an analytic output are not pre-registered within the specifictenant.

Remedy

Because of security considerations, prior to passing values as alert attributes via the custom properties ofan analytic output, you are required to first register all related keys in custom properties within thespecific tenant. This step allows the tenant to recognize these keys as valid, and properly pass the key-values to an alert as an attribute, allowing access and visualization in Alerts via the grid view. To registerkey(s) as custom attribute(s) recognizable by GE Digital APM, follow these steps:

1. Determine all keys to be registered.2. Register all keys per instructions in the API documentation. Select the link below to access the API

documentation:https://apm-apidocs-preprod.preprod-app-api.aws-usw02-pr.predix.io/alarms/#_create_custom_attribute

3. After you have registered all keys, pass the key-value pairs for alert custom properties in the requiredJSON format of the analytic output.

Related Information

#unique_17

Cannot Deploy an Analytic to Predix RuntimeYou cannot deploy an analytic even after completing all the required steps in deployment.

Condition

You have uploaded an analytic template and configured all required inputs, outputs, and constants. Yousuccessfully add a deployment with the configured Analytic Template. However, after completing all thesteps required in the deployment successfully, the error appears when you select Deploy. Thedeployment status remains Not Deployed.

Cause

The analytic template has not yet been uploaded to the analytic catalog. The current status of the analytictemplate still displays In Progress. Deployments cannot be staged to the Predix runtime unless theanalytics template is available in the catalog.

© 2020 General Electric Company 9

Page 14: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Remedy

Make sure that the current status of the analytic template used in your deployment no longer displays asIn Progress. Open the deployment in the edit mode. Navigate to the Review page, and then selectDeploy to stage the deployment to Predix runtime.

Verification

The deployment status should changes from Not Deployed to In Progress. This indicates that thedeployment has been uploaded to the runtime to be staged for execution.

Cannot Access Attributes in the Asset FilterIn the Analytics module, you cannot access a list of attributes during asset filter creation.

Condition

You are logged in to your tenant with the necessary privileges to access the Analytics module and apps.However, when you are adding a new asset filter, you are not able to see all required attributes to createthe filter.

Cause

You have not yet configured the attribute, or you have configured attributes that are not part of your assetmodel. Using non-existing model attributes in your analytics configuration will not add them to the assetmodel, nor will they show up for use in the asset filters as they do not exist in the system.

Remedy

Add the needed system attributes to the asset model in your tenant. Use system attributes that you haveingested in your analytics configuration. After, you have configured them, you can use them in the assetfilters.

Failed Analytics DeploymentYou cannot run the deployment successfully on Predix runtime.

Condition

You selected the deploy button to deploy an analytic to run on the Predix runtime. You had completed theasset selection, I/O mapping, scheduling, and review steps prior to deploying the analytic to the runtime.However, after running the deployment you see the following error message when you hover over theRun Once Failed deployment status:

“Invalid input port name <analyticInputName>. Cannot find it in ports to data source list.”

Cause

It is possible that the analytic generates alerts but the output event is not defined in your deployedanalytic template. This causes the alert ingestion to fail as no template definition can be found for it.

10 © 2020 General Electric Company

Page 15: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Remedy

Make sure that you have created alert templates and linked these templates as output events in youranalytic template configuration. This will ensure that any alert generated by the deployed analytic will bewritten to the correct alert template.

© 2020 General Electric Company 11

Page 16: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Chapter

4Dashboards TroubleshootingTopics:

• Context Browser is Empty• Page Failed to Load During

Navigation from Widget

12 © 2020 General Electric Company

Page 17: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Context Browser is EmptyWhile trying to add an asset context, no system activity is evident.

Condition

You are trying to add an asset context to an analysis chart or a dashboard using the Context Browser. Youselect the Context Browser, but the browser remains blank. There is no spinner indicating that the systemis working.

Cause

The system is trying to fetch data; however, unavoidable circumstances, such as network connectivity,may cause the system to time-out.

Remedy

1. Wait for the asset to load.2. Refresh the page.

Page Failed to Load During Navigation from WidgetThe page does not load when you select a widget that should access another module.

Condition

You select on a widget that is supposed to access a specific page in another dashboard or module. Thepage does not load and you receive a message Page failed to load, but there is no indication whatyou should do.

Cause

There are four possible causes:

• You do not have access to the specific module the widget is intended to access.• You selected a context for the navigation in configuration, but did not specify a dashboard.• The dashboard specified in the widget configuration was deleted.• The module specified in the widget configuration does not exist.

Remedy

• If you do not have access to the specified module, contact your administrator to add the properpermissions.

• For all other causes, refer to Configuring Navigation for Widgets on a Card.

Tip: Checking the navigation configuration for a widget helps you determine if it is set up correctly. Ifyou cannot find a dashboard or module in the View Selector in configuration, it may have been deleted.You can select the correct dashboard or module there.

Verification

After you have received the proper permissions and/or configured the widget correctly, try selecting thewidget again.

© 2020 General Electric Company 13

Page 18: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Chapter

5Ingestion TroubleshootingTopics:

• Troubleshoot Asset IngestionErrors

• Prolonged Ingestion Time• Error: Illegal Character ((CTRL-

CHAR, code 0))• Cannot See Ingested Time-

series Data on Analysis Page• Cannot Edit Tag Instance

Through REST Call• Error Ingesting Tags• Server Error Upon Updating a

Tag Group

14 © 2020 General Electric Company

Page 19: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Troubleshoot Asset Ingestion Errors

Before You BeginYou must have ingested at least one ZIP file containing the asset model to the tenant.

About This TaskThis procedure will help you troubleshoot ingestion errors from the APM application.

Procedure

1. Sign in to GE Digital APM.2. In the module navigation menu, go to Ingestion Setup.

Note:

In the Legacy Predix APM module navigation menu, navigate to Asset Ingestion.

The Asset Ingestion page appears, displaying the Ingestion Logs table.Note: The table displays the last 100 ingestion transactions for that tenant. If you want to viewtransactions prior to that, you can use the REST endpoint to get the status for a specific ingestion job.3. Review the ingestion log. Use one of the following methods to locate the ingestion file.

• Use the text search filters on top of each column to search for a specific file. You can search by theZIP File Name, Start Time or File Size. Enter your search criteria in the text field. The filter resultsare updated as you enter characters. The search is text-based and does not accept regularexpression. If you enter multiple filters, the search applies the AND operator and returns resultsthat match all filters.

• If you have multiple pages of results, use the page navigation at the bottom of the page to navigateto the file.

4. After you have located the ZIP file select the file link to open the ingestion log details page. The title ofthe page is same as the ingestion file name.

5. Analyze the Errors and Skipped Items sections in the page for troubleshooting any issues.

Next Steps

Refer to the Asset Ingestion Error Log to fix any errors.

Reingest the updated asset model and data after resolving the errors.

Asset Ingestion Error LogThe asset ingestion error log gives you a list of asset ingestion status and error messages that helps youtake the required corrective actions before reingesting the asset model and data.

Look at each error message; it contains a message string with embedded variables to help troubleshoot aspecific area in the ingestion JSON file. For example, in the error message, Invalid ccomClass"ENTTYPE" specified for Classification: "Company" contains text within doublequotes(""), which are values provided for a specific field. In the example message, ENTTYPE is an invalid value forthe field ccomClass. The message suggests that the Classification object defined with the ID valueCompany does not have a valid ccomClass value.

In the application user interface, actual values will replace the variable names represented within squarebrackets [ ] in the error messages below.

© 2020 General Electric Company 15

Page 20: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Table 1: Ingestion Error Messages and Corrective Actions

Error Message Corrective Action

JSON file [filename] is not well formed. Make sure that the JSON contained within the ZIP file is properly

formatted. Before zipping the file for upload, use a JSON validator

such as jsonlint or jsonformatter to check for JSON validity. Also

make sure that the JSON conforms to the expected asset model

schema.

Missing ID for Classification: [Name], Type: [ccomClass] Make sure that the ID field does not contain an empty string or null

value. You must fill the ID field for all elements in the classifications

block.

Missing ID for Instance: [Name], Type: [ccomClass] Make sure that the ID field does not contain an empty string or null

value. You must fill the ID field for all elements in the instances block.

Missing ID for Tag Classification: [Name] Make sure that the ID field does not contain an empty string or null

value. You must fill the ID field for all elements in the

tagClassfications block.

Missing ID for Tag: [Name], Monitored Entity: [ID] Make sure that the ID field does not contain an empty string or null

value. You must fill the ID field for all elements in the tagAssociations

block.

Missing ID for Connection: From [From ID] - Type

[ccomClass] To: [To ID] - Type [ccomClass]

You must define the instances before you can connect them. You can

have a parent-child relationship between instances. You define

connection from one instance to one or more instances. Make sure

that the ID field does not contain an empty string or null value. You

must fill the ID field for all instances linked in the connections block.

You must enter a valid and existing ID for already ingested instances

only.

Invalid field length for Attribute: [Attribute Name],

Instance: [ID]

The ID field limits values to 32768 characters (32KB) long. Make sure

that the ID values are no longer than the allowed limit.

Invalid field length for Attribute: [Attribute Name],

Classification: [ID]

The ID field limits values to 32768 characters (32KB) long. Make sure

that the ID values are no longer than the allowed limit.

Invalid field length for Attribute: [Attribute Name], Tag: [ID] The ID field limits values to 32768 characters (32KB) long. Make sure

that the ID values are no longer than the allowed limit.

Invalid field length for Attribute: [Attribute Name], Tag

Classification: [ID]

The ID field limits values to 32768 characters (32KB) long. Make sure

that the ID values are no longer than the allowed limit.

Invalid data type for Attribute: [Attribute Name], Instance:

[ID]

Enter one of the following supported datatypes in the property

object within the instances block.Refer to Refer to "Attribute Data

Types and Values" for the list of supported data-types and expected

values. Make sure that the value is within the expected range of the

datatype defined. For example, if the attribute has the datatype

INTEGER then the value provided must be of type integer only.

Otherwise, validation would fail.

16 © 2020 General Electric Company

Page 21: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Error Message Corrective Action

Invalid data type for Attribute: [Attribute Name],

Classifcation: [ID]

Enter one of the following supported datatypes in the property

object within the classifications block. Refer to Refer to "Attribute

Data Types and Values" for the list of supported data-types and

expected values. Make sure that the value is within the expected

range of the datatype defined. For example, if the attribute has the

datatype INTEGER then the value provided must be of type integer

only. Otherwise, validation would fail.

Invalid data type for Attribute: [Attribute Name], Tag: [ID] Enter one of the following supported datatypes in the property

object within the tags block. Refer to "Attribute Data Types and

Values" for the list of supported data-types and expected values.

Make sure that the value is within the expected range of the

datatype defined. For example, if the attribute has the datatype

INTEGER then the value provided must be of type integer only.

Otherwise, validation would fail.

Invalid data type for Attribute: [Attribute Name], Tag

Classification: [ID]

Enter one of the following supported datatypes in the property

object within the tagClassifications block. Refer to "Attribute Data

Types and Values" for the list of supported data-types and expected

values. Make sure that the value is within the expected range of the

datatype defined. For example, if the attribute has the datatype

INTEGER then the value provided must be of type integer only.

Otherwise, validation would fail.

Invalid ccomClass "ABC" specified for Instance: [ID] The APM s95 adapter uses four ccomClasses to represent the levels

within the asset model hierarchy. Each class instance must be tied to

one of the four ccomClasses: ENTERPRISE, SITE,

SEGMENT, and ASSET. It should also match the classification

ccomclass. For example, if the ccomClass for the classification is

Enterprise_type then the instance of that classification

must have the ccomClass Enterprise.

"ccomClass":"ENTERPRISE"

© 2020 General Electric Company 17

Page 22: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Error Message Corrective Action

Invalid ccomClass "ABC" specified for Classification: [ID] The APM s95 adapter uses four ccomClasses to represent the levels

within the asset model hierarchy. Each classification must be tied to

one of the four ccomClasses: ENTERPRISE_TYPE,

SITE_TYPE, SEGMENT_TYPE, and ASSET_TYPE. If

inherited, must match the ccomClass of the parent classification.

"ccomClass":"ASSET_TYPE"

Invalid ccomClass "ABC" specified for Connection From

[From ID] - Type [ccomClass] To: [To ID] - Type [ccomClass]

Make sure that ccomClass of the parent and child instances in the

connections block are correctly defined.

Keep in mind the following before connecting two instances:

• An enterprise object is the parent of one or more site objects.

• A site object is the parent of at least one segment or asset

object. A site object cannot be a parent of another site object.

• A segment object is the parent of at least one segment or asset

object.

• An asset object can be the parent of zero or more asset objects.

Prolonged Ingestion TimeAsset ingestion requests get queued for more than 15 minutes even for a small amount of data.

Condition

While using the POST method (command line or REST client) to ingest assets or alarms into APM, therequest gets queued and no POST response is received for more than 15 minutes. The system does notdisplay a progress message, and the request times out after several minutes. A sample time-out error isshown below:

ERROR: Failed to transform entity - G07893_InletBleedHeating. org.springframework.data.redis.RedisConnectionFailureException: java.net.SocketTimeoutException: Read timed out; nested exception is redis.clients.jedis.exceptions.JedisConnectionException: java.net.SocketTimeoutException: Read timed outFailed to transform entity - G07893_Standard. org.springframework.data.redis.RedisConnectionFailureException: Cannot get Jedis connection; nested exception is redis.clients.jedis.exceptions.JedisConnectionException: Could not get a resource from the poolFailed to transform entity - G07893_WasteHeatrecoveryUnit. org.springframework.data.redis.RedisConnectionFailureException: Cannot get Jedis connection; nested exception is redis.clients.jedis.exceptions.JedisConnectionException: Could not get a resource from the pool

18 © 2020 General Electric Company

Page 23: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Cause

Possible causes include the following:

• Communication loss between the adapter service in APM and RabbitMQ messaging server.• Redis configuration issue. This leads to the message getting stuck in RabbitMQ without getting pushed

to APM.

Remedy

1. Wait a few minutes, and then try to perform the ingestion again.2. If the issue recurs, select the following link to enter a support ticket: http://www.ge.com/digital/

support.

Error: Illegal Character ((CTRL-CHAR, code 0))You encounter an error when trying to retrieve the asset ingestion status.

Condition

You encounter an error message when you are trying to retrieve the status of asset ingestion progressthrough an HTTP request or Curl command.

Example of the curl command used to retrieve the ingestion status:

curl -X GET -H "Authorization: Bearer {token}" -H "Cache-Control: no-cache" -H "Postman-Token: 25c17ca8-7c2e-03ab-5d3a-c98e1a45764b" "http://apm-adapter-config-provider-qa.grc-apps.svc.ice.ge.com/v1/tasks/cc8c7c8d-2e39-4bd6-8c5a-d74d6ed490b1”

A sample error in the response is shown below:

{ "tenantUuid": "54E3F6572FB24AEAAA7A7B7925289FAB", "uuid": "cc8c7c8d-2e39-4bd6-8c5a-d74d6ed490b1", "description": "Upload S95 assets from zip file: data.json.zip, size: 1762 bytes", "status": "ERROR: Error in child task", "createdOn": 1457650900569, "updatedOn": 1457650900623, "children": [ { "tenantUuid": "54E3F6572FB24AEAAA7A7B7925289FAB", "uuid": "20baa545-4c10-43cb-8ea7-8fcbb41affe5", "description": "Process S95 assets file: __MACOSX/._data.json", "status": "ERROR: Illegal character ((CTRL-CHAR, code 0)): only regular white space (\r, \n, \t) is allowed between tokens\n at [Source: java.io.InputStreamReader@67db3666; line: 1, column: 2]", "createdOn": 1457650900608, "updatedOn": 1457650900620, "children": [] }, { "tenantUuid": "54E3F6572FB24AEAAA7A7B7925289FAB", "uuid": "39935989-547d-4a2e-b805-060d15317da0", "description": "Process S95 assets file: data.json", "status": "COMPLETED",

© 2020 General Electric Company 19

Page 24: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

"createdOn": 1457650900587, "updatedOn": 1457650905490, "children": [] } ]}

Cause

Using a compression utility that is built in with your operation system such as MAC OS inadvertently addsthe control character (CTRL-CHAR) to the end of each line in the JSON before compressing it. The ZIPfiles compressed and created this way will fail asset ingestion into APM.

Remedy

Make sure you use a compression utility that produces ZIP files without introducing the control character(CTRL-CHAR). You can use one of the following that applies to you:

• In Mac OS, compress the JSON into a ZIP file using command line compression utility.

zip -r archive_name.zip folder_to_compress• In Windows, use utilities such as 7-Zip or WinZip to create a ZIP file.

Verification

Perform the asset ingestion with the corrected ZIP file.

Cannot See Ingested Time-series Data on Analysis PageThe time-series data ingested for ingested tags do not appear in the Analysis page.

Condition

You ingested assets into APM, then ingested tagClassifications, then ingested tagAssociations, and thenthe time series data for tags that were added, but the time series data does not appear on the Analysispage.

Cause

It is possible that the tagId value in the time-series data does not match with the id value in theingested tags{}.

Remedy

Make sure that the id value in the tags and tagId value in time-series data match.

1. In tagAssociations JSON definition make sure that the tag id field matches that of the time-seriesdata. For example, if you are ingesting times-series data for the tagId value Inverter1-ASSET-TYPE1.Tag_Length your tags{} segment should look like the example code sample below.

{"tagAssociations": [ { "monitoredEntity": { "id": "Inverter1-ASSET-TYPE1",

20 © 2020 General Electric Company

Page 25: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

"ccomClass": "ASSET" }, "tags": [ { "id": "Inverter1-ASSET-TYPE1.Tag_Length", "name": "Tag Length", "classification": "Tag_Length", "unit": "inch", "properties": [ { "id": "alias", "value": ["TAG_1"], "type": "string" } ] } ]}

2. Delete the discrepant tags.3. Reingest the tag associations and tags.4. If needed, ingest new time-series data for the defined tags and make sure they have the correct

tagId value.

Verification

After ingesting assets, tags, and time-series data; login to the APM and access the Analysis page to seethe time-series data.

Cannot Edit Tag Instance Through REST CallIf you add a new tag instance with source key id that already exists, the new tags will not be added orupdated.

Condition

You ingest tags {} using the POST method with an existing tag id in your APM tenant. The tag instance isnot ingested into APM.

Cause

You cannot use the POST method to update tag instances. The tag fields are not updated with thechanged details as this is the expected behavior. You can use POST to add new tags but cannot use it toupdate tags.

Remedy

Use the APM user interface to edit tag details: Manage Assets > Select a tag > Edit tag. Follow theEditing Tags procedure.

© 2020 General Electric Company 21

Page 26: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

Error Ingesting TagsYou encounter an error after ingesting tagClassifications and tagAssociations using the HTTP POSTmethod

Condition

You try ingesting tags using an older version of s95 JSON format like shown in the code example below:

{ "tags": [ { "id": "ASSET_TAG_ID_operMode", "name": "operMode", "description": "Oper Mode tag", "unitGroup": "string", "properties": [ { "id": "GId", "type": "string", "value": [ "Oper Mode" ] }, { "id": "type", "type": "string", "value": [ "enum" ] }, { "id": "writable", "type": "boolean", "value": [ true ] }, { "id": "enum", "type": "string", "value": [ "Off", "Cooling", "Heating" ] } ] } ], "tagAssociations": [ { "monitoredEntity": { "id": "ASSET_INSTANCE_xyz123", "ccomClass": "ASSET" }, "tags": [ {

22 © 2020 General Electric Company

Page 27: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

"id": "ASSET_TAG_ID_operMode", "classification": "ASSET_TAG_ID_operMode", "unit": "string" } ] } ]}

You encounter the following error:

{ "tenantUuid": "C783D57F24DA4705B612366B3A50219B", "uuid": "e297ed0d-6c65-4fdd-9cf7-b5ef5ca3c886", "description": "Process S95 assets file: tag.json", "status": "ERROR: Expected END_OBJECT but was START_OBJECT\n at [Source: java.io.InputStreamReader@5c5f2a31; line: 6, column: 6]", "createdOn": 1459366516959, "updatedOn": 1459366517184, "children": [] }

Cause

The tag classification was missing for the ingested tag instance. For example, in the sample code below,the tag classification id referenced in the "tags": [ ] block has not yet been created. Due to themissing tag classification, the ingestion fails.

"tags": [ { "id": "ASSET_TAG_ID_operMode", "classification": "ASSET_TAG_ID_operMode", "unit": "string" }

Remedy

Make sure that "tagClassifications": [ ] block is labeled appropriately in your JSON. Tagclassifications must be ingested before ingesting tagAssociations. The "tags": [ ] block must beincluded inside the "tagAssociations": [ ] block. If you are using an older version (2.0 or before)of the s95 JSON file. Make sure you have the "tagClassifications": [ ] block as shown in thecode example below:

{ "tagClassifications": [ { "id": "ASSET_TAG_ID_operMode", "name": "operMode", "description": "Oper Mode tag", "unitGroup": "string", "properties": [ { "id": "GId", "type": "string", "value": [ "Oper Mode" ] },

© 2020 General Electric Company 23

Page 28: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

{ "id": "type", "type": "string", "value": [ "enum" ] }, { "id": "writable", "type": "boolean", "value": [ true ] }, { "id": "enum", "type": "string", "value": [ "Off", "Cooling", "Heating" ] } ] } ]

Verification

Reingest the tagClassifications and tagAssociations using the HTTP POST and make sure it getsprocessed correctly.

Server Error Upon Updating a Tag GroupYou receive a server error upon updating a tag group.

Condition

Using the PATCH method to update a tag group with a non-existing URI gives a internal server error.

Ideally, when updating the tag group with URI which doesn't exist, the service should throw 404 NOTFOUND exception, and return the error message in the response body.

Instead, the service throws 500 INTERNAL SERVER ERROR with the following error message:

{ "path": "/v1/groups/0678912f-871e-4e70-bb2c-a24e1a9148b0-notexists", "requestId": "85b626ed-2200-4d06-902e-8d9de8bce9f7", "errorId": "UPDATE_SINGLE", "errorMessage": "Failed to create for uri: /groups/0678912f-871e-4e70-bb2c-a24e1a9148b0-notexists", "timestamp": 1456967581879}Curl command to reference: curl-X PATCH-H"Authorization: Bearer eyJhbGciOiJSUzI1NiJ9..."-H"Tenant: 54E3F6572FB24AEAAA7A7B7925289FAB"-H"Content-Type: application/json"-H"Cache-Control: no-cache"-H"Postman-Token: dea2d406-6701-79f5-4733-2b7793864524"-d'[{

24 © 2020 General Electric Company

Page 29: Troubleshooting - GE€¦ · Chapter 3: Analytics Troubleshooting 7 Cannot Access Application Analytics Module and Apps 8 Cannot Access Application Analytics Module and/or Features

"op": "replace", "path": "/name", "value": "Updated"}]'"http://apm-asset-qa.grc-apps.svc.ice.ge.com/v1/groups/0678912f-871e-4e70-bb2c-a24e1a9148b0-notexists"

Cause

The service returns the 500 INTERNAL SERVER ERROR instead of 404 NOT FOUND.

Remedy

When you perform a tag group update using the PATCH method, make sure that URI exists in the datastore.

Verification

On successful update, you receive the 200 OK response.

© 2020 General Electric Company 25