Skip to main content
Pentaho Documentation

Troubleshooting AEL

Parent article

Follow the suggestions in these topics to help resolve common issues with running transformations with the Adaptive Execution Layer.

Steps cannot run in parallel

If you are using the Spark engine to run a transformation with a step that cannot run in parallel, it generates errors in the log.

Some steps cannot run in parallel (on multiple nodes in a cluster), and will produce unexpected results. However, these steps can run as a coalesced dataset on a single node in a cluster. To enable a step to run as a coalesced dataset, add the step ID as a property value in the configuration file for using the Spark engine.

Get the step ID

Each PDI step has a step ID, a globally unique identifier of the step. Use one of the following methods to get the ID of a step:

Method 1: Retrieve the ID from the PDI client

You can retrieve a step ID though the PDI client with the following steps:

Procedure

  1. From the menu bar in the PDI client, select Tools Show plugin information.

    The Plugin browser appears.
  2. Select Step in the Plugin type menu to filter by step name, and find your step name in the table to obtain the related ID.

Method 2: Retrieve the ID from the log

You can retrieve a step ID though the PDI client logs with the following steps:

Procedure

  1. In the PDI client, create a new transformation and add the step to the transformation.

    For example, if you needed to know the ID for the Select values step, you would add that step to the new transformation.
  2. Set the log level to debug.

  3. Execute the transformation using the Spark engine.

    The step ID displays in the Logging tab of the Execution Results pane. For example, the log displays Selected the SelectValues step to run in parallel as a GenericSparkOperation, where SelectValues is the step ID.

Method 3: Retrieve the ID from the PDI plugin registry

If you are a developer, you can retrieve the step ID from the PDI plugin registry as described in Dynamically build transformations.

NoteIf you have created your own PDI transformation step plugin, the step ID is one of the annotation attributes that the developer supplies.

Add the step ID to the configuration file

The configuration file, org.pentaho.pdi.engine.spark.cfg, contains the forceCoalesceSteps property. The property is a pipe-delimited listing of all the IDs for the steps that should run with a coalesced dataset. Pentaho supplies a default set to which you can add IDs for steps that generate errors.

Perform the following steps to add another step ID to the configuration file:

Procedure

  1. Navigate to the data-integration/system/karaf/etc folder on the edge node running the AEL daemon and open the org.pentaho.pdi.engine.spark.cfg file.

  2. Append your step ID to the forceCoalesceSteps property value list, using a pipe character separator between the step IDs.

  3. Save and close the file.

Force coalesce and Spark tuning

Any steps to the org.pentaho.pdi.engine.spark.cfg force coalesce configuration file do a coalesce. If the stepTuningOverrideForceCoalesceList application.properties setting is set to true, then step tuning takes precedence over force coalesce.

Table Input step fails

If you run a transformation using the Table Input step with a large database, the step does not complete. Use one of the following methods to resolve the issue:

Method 1: Load the data to HDFS before running the transform

  1. Run a different transformation using the Pentaho engine to move the data to the HDFS cluster.

  2. Then use HDFS Input to run the transformation using the Spark engine.

Method 2: Increase the driver side memory configuration

Procedure

  1. Navigate to the config/ folder and open the application.properties file.

  2. Increase the value of the sparkDriverMemory parameter, then save and close the file.

Next steps

Method 3: Adjust JDBC tuning options

  1. Right-click on the Table Input step in the PDI client canvas, then select Spark tuning parameters from the menu.

    The Spark tuning parameters dialog box appears. See Setting PDI step Spark tuning options for instructions.
  2. Adjust the JDBC tuning options as needed.

    See JDBC tuning options for details.

User ID below minimum allowed

If you are using the Spark engine in a secured cluster and an error about minimum user ID occurs, the user ID of the proxy user is below the minimum user ID required by the cluster. See Cloudera documentation for details.

To resolve, change the ID of the proxy user to be higher than the minimum user ID specified for the cluster.

Hadoop version conflict

On an HDP cluster, if you receive the following message, your Hadoop library is in conflict and the AEL daemon along with the PDI client might stop working:

command hdp-select is not found, please manually *export HDP_VERSION* in spark-env.sh or current environment

To resolve the issue, you must export the HDP_VERSION variable using a command like the following example:

export HDP_VERSION=${HDP_VERSION:-2.6.0.3-8}

The HDP version number should match the HDP version number of the distribution on the cluster. You can check your HDP version with the hdp-select status hadoop-client command.

Hadoop libraries are missing

If you use the Spark libraries packaged with EMR, Cloudera, and Hortonworks’ distributions, you must add the Hadoop libraries to the classpath with the SPARK_DIST_CLASSPATH environment variable. These distributions are not packaged with the Hadoop libraries. For EMR, these libraries are required to access S3 resources.

Add the class path

The following command will add the libraries to the classpath:

export SPARK_DIST_CLASSPATH=$(hadoop classpath)

You can add this command to the daemon.sh file so you do not have run this command every time you the start the AEL daemon.

Set Spark home variable

If you are using the Spark client from the Cloudera or Hortonworks Hadoop distributions, you may also receive the following log error:
Exception in thread "main" java.lang.NoSuchFieldError: TOKEN_KIND

If you received this log error, you must also complete the following steps for your Hadoop distribution:

Procedure

  1. Download the Spark client for your Hadoop cluster distribution (Cloudera or Hortonworks).

  2. Navigate to the adaptive-execution/config directory and open the application.properties file.

  3. Set the sparkHome location to where Spark 2 is located on your machine.

Example for Cloudera:

sparkhome = /opt/cloudera/parcels/SPARK2/lib/spark2

Example for Hortonworks:

sparkhome =/opt/horton/SPARK2/lib/spark2

Spark libraries conflict with Hadoop libraries

In some cases, library versions contained in JARs from PDI, Spark, Hadoop, AEL, and/or Kettle plugins may conflict with one another, causing general problems where Spark libraries conflict with Hadoop libraries and potentially creating AEL-specific problems. To read more about this issue, including how to address it, see the article AEL and Spark Library Conflicts on the Pentaho Community Wiki.

Failed to find AVRO files

If you are using the Spark engine with an EMR cluster, you may receive the following error message when trying to access AVRO files:

Failed to find data source: org.apache.spark.sql.avro.AvroFileFormat. Please find packages
        at http://spark.apache.org/third-party-projects.html

The libraries needed for accessing AVRO files on an EMR cluster are not included in Spark default class path. You must add them to the AEL daemon extra/ directory.

To resolve the issue, copy the vendor-supplied data source JAR libraries on the /usr/lib/spark/external/lib/ directory, such as "file spark-avro_2.11_2.4.2.jar" for example, to the AEL extra/ directory on the daemon, as shown in the following example:

cp /usr/lib/spark/external/lib/spark-avro_2.22_2.4.2.jar
        $AEL_DAEMON_DIRECTORY/data-integration/adaptive-execution/extra/

Unable to access Google Cloud Storage resources

You might receive an error message when trying to access Google Cloud Storage (GCS) resources. The URIs starting with gs://, such as "gs://mybucket/myobject.parquet" for example, require specific cluster or AEL configurations.

To resolve the issue, see Google Cloud Storage for instructions.

Unable to access AWS S3 resources

You might receive an error message when trying to access AWS S3 resources. The URIs starting with s3://, s3n://, or s3a://, such as "s3://mybucket/myobject.parquet" for example, require specific cluster configurations.

To resolve the issue for an EMR cluster, see Hadoop libraries are missing for instructions.

To resolve the issue for a Cloudera or Hortonworks cluster, see the following vendor-specific cluster documentation for details:

JAR file conflict in Kafka Consumer step

When using the Kafka Consumer step with HDP 3.x on AEL Spark, there is a known conflict with the JAR file /usr/hdp/3.x/hadoop-mapreduce/kafka-clients-0.8.2.1.jar

Use one of the following solutions to resolve the JAR conflict.

  • On HDP 3.x do not set the SPARK_DIST_CLASSPATH variable before running the Adaptive Execution Layer daemon. Otherwise, there may be issues in other AEL components.
  • Exclude the JAR file from the path on SPARK_DIST_CLASSPATH with the spark-dist-classpath.sh script. Create the script with any text editor and include the following code:
    #!/bin/sh
    ##
    ## helper script for setting up SPARK_DIST_CLASSPATH for AEL
    ## removes conflicting JAR files existing in HDP 3.x
    ## Using: call this the same way you use hadoop classpath, command, i.e.:
    ## export SPARK_DIST_CLASSPATH=$(spark-dist-classpath.sh)
    
    # grab hadoop classpath
    HCP=`hadoop classpath`
    
    ## expand it to grab all jar files
    (
      for entry in `echo "$HCP" | sed -e 's/:/\n/g'` ; do
         ## clean up dirs ending with *
         entryCleaned=`echo "$entry" | sed -e 's/\*$//'`
         ## if dir, expand it
         if test -d $entryCleaned ; then
           find $entryCleaned  
         else
           echo "$entry"
         fi 
      done 
    ) | grep -v kafka-clients-0.8.2.1.jar |  paste -s -d: 
    
    exit
    

Internet Address data type fails

When running an AEL transformation using an input step with the data type 'Internet Address' selected for a URL field, your transformation may not complete properly.

When you are using the Spark engine to run an AEL transformation, do not use the data type 'Internet Address' when entering a URL in a step. Instead, use the data type 'String' for the URL.

Message size exceeded

If you are using the Spark engine to run an AEL transformation and an error is generated indicating a decoded message was too big for the output buffer, you need to increase the maximum size (2 MB by default) of the message buffers for your AEL environment.

Perform the following steps to increase the message buffer limit:

Procedure

  1. Stop the AEL daemon.

  2. Navigate to the data-integration/adaptive-execution/config directory and open the application.properties file using a text editor.

  3. Enter the following incoming WebSocket message buffer properties, setting the same value for each property:

    PropertyValue
    daemon.websocket.maxMessageBufferSizeThe maximum size (in bytes) for the message buffer on the AEL daemon. For example, to allocate a 4 MB limit, set the memory value as shown here:
    daemon.websocket.maxMessageBufferSize=4000000
    driver.websocket.maxMessageBufferSizeThe maximum size (in bytes) for the message buffer on the AEL Spark driver. For example, to allocate a 4 MB limit, set the memory value as shown here:
    driver.websocket.maxMessageBufferSize=4000000
  4. Save and close the file.

  5. Restart the AEL daemon.

Results

When the AEL daemon submits the AEL Spark driver application, it passes the driver’s maximum message buffer size value as part of the submit; then, when the driver application is started, it receives the maximum buffer size value sent by the daemon.

Spark SQL catalyst errors using the Merge or Group By steps

If you are using the Spark engine with the Merge Rows (diff), Merge Join, or Group By step, you might receive an error similar to the following message:

org.apache.spark.sql.catalyst.analysis.package$AnalysisErrorAt.failAnalysis(package.scala:42)
org.apache.spark.sql.catalyst.analysis.Analyzer.checkAnalysis(Analyzer.scala:91)

Field names for join keys (values to compare or group) cannot contain special characters, such as whitespaces or dashes.

To resolve the issue, remove the special characters from the field names within your transformation.

Performance or memory issues

If you experience performance or memory issues while running your PDI transformation on the Spark engine, your transformation may not be efficiently using Spark execution resources.

To resolve or minimize the issue, apply and adjust application and PDI step Spark tuning parameters. See About Spark tuning in PDI for details.

Multiple steps in a transformation cannot generate files to the same location

If your transformation contains multiple steps that generate output files to the same destination folder, the files might be missing or the data might be missing.

Spark requires unique names for the files and folders generated by each step. To resolve this issue, send the files from each step to unique folders with unique filenames.