pg instrumentation: enhancedDatabaseReporting value is not parsable

[blumamir]

What version of OpenTelemetry are you using?

"@opentelemetry/instrumentation-pg": "0.31.1"

What version of Node are you using?

16

What did you do?

Executed the following pg query with instrumentation config enhancedDatabaseReporting: true

    const res = await client.query('SELECT $1::text as message1, $2::text as message2', ['Hello,World', 'foo,bar']);

What did you expect to see?

I expected to be able to tell what the query values are for this operation.

What did you see instead?

I got this value in the db.postgresql.values attribute: "[Hello,World,foo,bar]"
This text is not reversible. all of these arrays will yield the same attribute value and there is no way to differentiate them in a deterministic way:

['Hello,World', 'foo,bar']
['Hello', 'World,foo,bar']
['Hello,World,foo', 'bar']

Additional context

The reason is that this data is serialized in a non-standard, non-reversible way:

function arrayStringifyHelper(arr: Array<unknown>): string {
  return '[' + arr.toString() + ']';
}

I suggest using JSON.stringify

[blumamir]

This serialization also fails to distinguish between types:

['foo', 6]
['foo', '6']

are both serialized into the attribute with the same value: "[foo,6]"

[github-actions]

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

[haddasbronfman]

Can you assign this to me?

[haddasbronfman]

after this pr open-telemetry/opentelemetry-specification#3092 will be merged, the function arrayStringifyHelper is no more needed because bd.bind.values will be an array anyway. The fix will be to just use the arr as is, and delete the function arrayStringifyHelper from pg (and mysql) instrumentations.

[github-actions]

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

[haddasbronfman]

Currently in work in this PR: #1453