Skip to content

Documentation Fix : logging.log.entry metadata has wrong object format #1996

Closed
Closed
Documentation Fix : logging.log.entry metadata has wrong object format#1996
Assignees
callmehiphop
Labels
api: loggingIssues related to the Cloud Logging API.priority: p0Highest priority. Critical issue. P0 implies highest priority.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.

Description

@eighteyes
eighteyes
opened on Feb 14, 2017

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

  1. stephenplusplus
    added
    api: loggingIssues related to the Cloud Logging API.
    docs
    on Feb 14, 2017
  2. danoscarmike
    assigned
    stephenplusplus
    and
    callmehiphop
    and unassigned
    stephenplusplus
    on Feb 27, 2017
  3. danoscarmike
    added
    Status: Release Blocking
    priority: p0Highest priority. Critical issue. P0 implies highest priority.
    type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.
    on Feb 27, 2017

  4. callmehiphop commented on Mar 2, 2017

    @callmehiphop
    callmehiphop
    on Mar 2, 2017
    Contributor

    @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?

  5. stephenplusplus commented on Mar 3, 2017

    @stephenplusplus
    stephenplusplus
    on Mar 3, 2017
    Contributor

    Yeah, it is meant to work as shown in the After section of #1666.

    @eighteyes I actually get the opposite behavior that you describe from a fresh install of @google-cloud/[email protected]. Can you try un- and re-installing to be sure you're using the latest version?

  6. eighteyes commented on Mar 6, 2017

    @eighteyes
    eighteyes
    on Mar 6, 2017 via email
    Author

  7. stephenplusplus commented on Mar 6, 2017

    @stephenplusplus
    stephenplusplus
    on Mar 6, 2017
    Contributor

    Phew 👍

  8. stephenplusplus
    closed this as completedon Mar 6, 2017
  9. sofisl
    added 2 commits that reference this issue on Feb 24, 2026

    fix: Add missing type for exposed database id (#1996)

    dfec226

    chore(main): release 7.4.0 (#1996)

    af1fe0e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

api: loggingIssues related to the Cloud Logging API.priority: p0Highest priority. Critical issue. P0 implies highest priority.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions