Classes like "SentryEnvelope" and plenty of other things are marked as Internal, even though ITransport relies on them

[Alexander-poolside]

Integration

sentry

Java Version

17

Version

8.21.1

Steps to Reproduce

1. I can pass my own transport factory via options, in case I don't want to just send the Sentry events via http to DSN:

   sentry-java/sentry/src/main/java/io/sentry/SentryOptions.java

   Lines 1181 to 1184 in 23d6b12

   	public void setTransportFactory(@Nullable ITransportFactory transportFactory) {
   	this.transportFactory =
   	transportFactory != null ? transportFactory : NoOpTransportFactory.getInstance();
   	}

2. To do this, I have to implement the ITransport interface - https://github.com/getsentry/sentry-java/blob/main/sentry/src/main/java/io/sentry/transport/ITransport.java
3. This interface defines a method send, and the first parameter is SentryEnvelope. Makes sense.
4. https://github.com/getsentry/sentry-java/blob/main/sentry/src/main/java/io/sentry/SentryEnvelope.java#L14-L15 - it turns out SentryEnvelope is marked as Internal. Just as a lot of other things.

SentryEnvelopeHeader, SentryEnvelopeItem, SentryEvent is not, but SentryItemType is.

Expected Result

I can define my custom transport and override sending the events, as something supported by the API.

Actual Result

The relevant code is marked as Internal, making tools like intellij plugin compat verifier fail.

Here are some screenshots:

[linear]

JAVA-175 Classes like "SentryEnvelope" and plenty of other things are marked as Internal, even though ITransport relies on them

[lcian]

Thank you for reporting, @Alexander-poolside
I think we can safely remove those 👍

[Alexander-poolside]

Thank you!

While we are at it, are there any plans on improving the custom transport support? Alas, I was not able to find any information about this in issues or docs.

For example, in JS SDK there are helpers and wrappers, and people can create their own transport for sending the messages, but with retry mechanism, for example, see https://docs.sentry.io/platforms/javascript/configuration/transports/

On the contrary, the current send signature does not even allow to return a result to indicate if the custom transport succeeded or not in sending the message.

[adinauer]

Hello @Alexander-poolside we currently have no plans on making implementing your own ITransport simpler. We consider this an advanced use case and it's probably best to take a look at our implementation when creating your own at the time you do it.

On the contrary, the current send signature does not even allow to return a result to indicate if the custom transport succeeded or not in sending the message.

The transport uses Hint to do this, which causes e.g. callbacks to be executed, retry to be performed etc.