Consider adding GraalVM reflection/resource configuration for aws-xray-sdk

[kwojcik-blockether]

AWS Xray SDK does not expose the configuration for GraalVM native-image, which makes it hard to integrate the library with it. Some of the frameworks like quarkus rely on their custom builder recipes to feed native-image with correct reflection/resource configurations.

Here is the example

I think aws-xray-sdk should ship with the correct options in META-INF as specified in the following documentation to ease the pain of integrating library with GraalVM.

[kwojcik-blockether]

This is reflect-config.json file needed for AWS X-ray to work in native-image:

[
  {
    "name": "com.amazonaws.xray.handlers.config.AWSServiceHandlerManifest",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.AWSXRay",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.strategy.sampling.manifest.SamplingRuleManifest",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.strategy.sampling.rule.SamplingRule",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.strategy.sampling.reservoir.Reservoir",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.strategy.sampling.reservoir.Reservoir$MaxFunction",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.strategy.sampling.reservoir.Reservoir$LessThan10",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.strategy.sampling.reservoir.Reservoir$AtLeast10",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.auth.AWS4Signer",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.handlers.config.AWSOperationHandlerManifest",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.handlers.config.AWSOperationHandler",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.handlers.config.AWSOperationHandlerRequestDescriptor",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.handlers.config.AWSOperationHandlerResponseDescriptor",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.entities.ThrowableDescription",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.entities.SubsegmentImpl",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.entities.EntityImpl",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.entities.TraceID",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.entities.Cause",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.amazonaws.xray.entities.SegmentImpl",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  },
  {
    "name": "com.fasterxml.jackson.databind.ser.std.ToStringSerializer",
    "allPublicMethods": true,
    "allPublicConstructors": true,
    "allDeclaredFields": true,
    "allDeclaredMethods": true,
    "allDeclaredConstructors": true
  }
]

This is resource-config.json needed for AWS x-ray to work:

{
  "resources" : {
    "includes" : [ {
      "pattern" : "\\Qcom/amazonaws/xray/interceptors/DefaultOperationParameterWhitelist.json\\E"
    }, {
      "pattern" : "\\Qcom/amazonaws/xray/sdk.properties\\E"
    }, {
      "pattern" : "\\Qcom/amazonaws/xray/strategy/sampling/DefaultSamplingRules.json\\E"
    }, {
      "pattern" : "\\Qsoftware/amazon/awssdk/global/handlers/execution.interceptors\\E"
    }, {
      "pattern" : "\\Qsoftware/amazon/awssdk/services/s3/execution.interceptors\\E"
    } ]
  },
  "bundles" : [ ]
}

EDIT: I can submit a patch to a library if that's necessary.

[anuraaga]

Thanks @FieryCod - if you're able to send a patch that would be great, this looks mostly straight forward.

This is reflect-config.json file needed for AWS X-ray to work in native-image:

My understanding is graal would only need these for code that is accessed through reflection. I understand many of the classes are because Jackson accesses the fields reflectively, but there seem to be some like "name": "com.amazonaws.xray.strategy.sampling.reservoir.Reservoir", and friends that don't. Do you know if these should be included?

[msailes]

I've submitted a PR #311

[kwojcik-blockether]

Tested the PR done by @msailes. Can confirm it works fine.

[kwojcik-blockether]

Closing the issue and waiting for the release. Good job @msailes! :)

[itsamitksingh]

This does not work in native build while using controller-based approach

[msailes]

@amitkumar7566 could you make a new issue with details of your problem.

Thanks,