Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve logging to show useful information #1207

Closed
jonaslagoni opened this issue Apr 2, 2023 · 2 comments
Closed

Improve logging to show useful information #1207

jonaslagoni opened this issue Apr 2, 2023 · 2 comments
Labels
enhancement New feature or request stale

Comments

@jonaslagoni
Copy link
Member

jonaslagoni commented Apr 2, 2023

Reason/Context

The current logging output is unusable... Finding usefull information is impossible when it prints everything in objects.

I am suggesting that we try to print only a limited amount of information, that which is relevant to the function we are logging in, and never full objects.

For example when we merge models it prints out:

Found duplicate additionalItems for model. additionalItems from GitCommit merged into GithubLocationConfig <ref *1> CommonModel {
  originalInput: Draft7Schema {
    type: 'object',
    properties: Draft7Schema { type: [Draft7Schema], config: true },
    allOf: [ [Draft7Schema], [Draft7Schema] ],
    'x-modelgen-inferred-name': 'AfterAction'
  },
  type: [
    'object',  'string',
    'number',  'array',
    'boolean', 'null',
    'integer'
  ],
  properties: {
    repo: CommonModel {
      originalInput: [Draft7Schema],
      type: 'string',
      '$id': 'GithubLocationConfig_repo',
      properties: undefined,
      extend: undefined
    },
    branch: CommonModel {
      originalInput: [Draft7Schema],
      type: 'string',
      '$id': 'GithubLocationConfig_branch',
      properties: undefined,
      extend: undefined
    },
    'meta-location': CommonModel {
      originalInput: [Draft7Schema],
      type: 'string',
      '$id': 'GithubLocationConfig_meta-location',
      properties: undefined,
      extend: undefined
    },
    'package-location': CommonModel {
      originalInput: [Draft7Schema],
      type: 'string',
      '$id': 'GithubRepositoryPackage_package-location',
      properties: undefined,
      extend: undefined
    },
    script: CommonModel {
      originalInput: [Draft7Schema],
      type: 'string',
      '$id': 'PackageAction_script',
      properties: undefined,
      extend: undefined
    }
  },
  '$id': 'GithubLocationConfig',
  extend: undefined,
  additionalProperties: [Circular *1],
  additionalItems: [Circular *1]
} CommonModel {
  originalInput: Draft7Schema { 'x-modelgen-inferred-name': 'GitCommit' },
  additionalItems: <ref *1> CommonModel {
    originalInput: Draft7Schema {
      type: 'object',
      properties: [Draft7Schema],
      allOf: [Array],
      'x-modelgen-inferred-name': 'AfterAction'
    },
    type: [
      'object',  'string',
      'number',  'array',
      'boolean', 'null',
      'integer'
    ],
    properties: {
      repo: [CommonModel],
      branch: [CommonModel],
      'meta-location': [CommonModel],
      'package-location': [CommonModel],
      script: [CommonModel]
    },
    '$id': 'GithubLocationConfig',
    extend: undefined,
    additionalProperties: [Circular *1],
    additionalItems: [Circular *1]
  },
  '$id': 'GitCommit'
} Draft7Schema {
  type: 'object',
  properties: Draft7Schema {
    type: Draft7Schema {
      type: 'string',
      description: 'The type of post-action for automator to run, after action has been run',
      enum: [Array],
      'x-modelgen-inferred-name': 'AfterAction_type'
    },
    config: true
  },
  allOf: [
    Draft7Schema {
      if: [Draft7Schema],
      then: [Draft7Schema],
      'x-modelgen-inferred-name': 'AfterAction_allOf_0'
    },
    Draft7Schema {
      if: [Draft7Schema],
      then: [Draft7Schema],
      'x-modelgen-inferred-name': 'AfterAction_allOf_1'
    }
  ],
  'x-modelgen-inferred-name': 'AfterAction'
}

IMO the following is enough:

Found duplicate additionalItems for model. additionalItems from GitCommit merged into GithubLocationConfig
@jonaslagoni jonaslagoni added the enhancement New feature or request label Apr 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 1, 2023

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Aug 1, 2023
@jonaslagoni
Copy link
Member Author

Re-creating as part of a larger re-write of logs

@jonaslagoni jonaslagoni closed this as not planned Won't fix, can't repro, duplicate, stale Jan 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request stale
Projects
None yet
Development

No branches or pull requests

1 participant