Repository navigation
Documentation Fix : logging.log.entry metadata has wrong object format #1996
Description
Overview
Documentation Object Inconsistencies
Working
https://googlecloudplatform.github.io/google-cloud-node/#/docs/logging/0.7.0/logging
Describes the entry metadata.
var resource = {
type: 'gce_instance',
labels: {
zone: 'global',
instance_id: '3'
}
};Breaking
https://googlecloudplatform.github.io/google-cloud-node/#/docs/logging/0.7.0/logging/entry
Wraps it in a resource key.
var metadata = {
resource: {
type: 'gce_instance',
labels: {
zone: 'global',
instance_id: '3'
}
}
};Reproduction
var metadata = {
resource: {
type: 'gce_instance',
labels: {
zone: 'global',
instance_id: '3'
}
}
};
var logFn = logging.log('sysout');
var entry = logFn.entry(metadata, {
msg: 'abc123'
});
logFn.write(entry, cb)Throws the following protobuf error
Uncaught Error: .google.api.MonitoredResource#resource is not a field: undefined
Resolution
Unwrapping the resource key from the field seems to be key here. This form also exists in the logging.entry doc, but I'm not sure what is intended there.
Activity
callmehiphop commentedon Mar 2, 2017
@stephenplusplus based on #1666 I think that the documentation is correct but code is not working as expected. Can you confirm that we did not intentionally revert those changes at some point?
stephenplusplus commentedon Mar 3, 2017
Yeah, it is meant to work as shown in the
Aftersection of #1666.@eighteyes I actually get the opposite behavior that you describe from a fresh install of @google-cloud/logging@0.7.0. Can you try un- and re-installing to be sure you're using the latest version?
eighteyes commentedon Mar 6, 2017
stephenplusplus commentedon Mar 6, 2017
Phew 👍
fix: Add missing type for exposed database id (#1996)
chore(main): release 7.4.0 (#1996)